commander

README

cmd

cmd is framework to make simple command. cmd is suitable for that has plenty of subcmd

Documentation

Index

• Variables
• type Command
  • func NewCommand(cmd Commander) Command
  • func (c *Command) Register(cmd Commander)
  • func (c *Command) SetHelp(help string)
• type CommandManager
  • func (c *CommandManager) Register(cmd Commander)
  • func (c *CommandManager) Run(ctx context.Context) error
• type Commander
• type Manage
  • func NewCommandManager() *Manage
  • func (m *Manage) Build() *CommandManager
  • func (m *Manage) WithHelp(b bool) *Manage
  • func (m *Manage) WithStderr(w io.Writer) *Manage
  • func (m *Manage) WithStdout(w io.Writer) *Manage

Variables

var (
	ErrNoCommand             = errors.New("No command provided")
	ErrCommandNotImplemented = errors.New("Command not implemented")
	ErrDisableHelp           = errors.New("Help command is disabled")
)

Types

type Command

type Command struct {
	Commander
	// contains filtered or unexported fields
}

func NewCommand

func NewCommand(cmd Commander) Command

func (*Command) Register

func (c *Command) Register(cmd Commander)

func (*Command) SetHelp

func (c *Command) SetHelp(help string)

type CommandManager

type CommandManager struct {
	// contains filtered or unexported fields
}

func (*CommandManager) Register

func (c *CommandManager) Register(cmd Commander)

func (*CommandManager) Run

func (c *CommandManager) Run(ctx context.Context) error

type Commander

type Commander interface {
	Name() string
	Short() string
	Long() string
	SetFlags(f *pflag.FlagSet)
	Run(ctx context.Context) error
}

type Manage

type Manage struct {
	Stdout, Stderr io.Writer
	// if true, the help command will be added to the command list
	// Help is used for all commands.
	// default is true
	Help *bool
}

func NewCommandManager

func NewCommandManager() *Manage

func (*Manage) Build

func (m *Manage) Build() *CommandManager

func (*Manage) WithHelp

func (m *Manage) WithHelp(b bool) *Manage

func (*Manage) WithStderr

func (m *Manage) WithStderr(w io.Writer) *Manage

func (*Manage) WithStdout

func (m *Manage) WithStdout(w io.Writer) *Manage