Documentation
¶
Index ¶
- Variables
- type Cmd
- type Command
- type CommandAdder
- type CommandDescriptor
- type CommandManager
- func (m *CommandManager) Command() Command
- func (m *CommandManager) Input(question string) (string, error)
- func (m *CommandManager) Log(message string)
- func (m *CommandManager) Logf(format string, args ...interface{})
- func (m *CommandManager) ProtectedInput(question string) (string, error)
- func (m *CommandManager) Registry() Registry
- func (m *CommandManager) Stderr() io.Writer
- func (m *CommandManager) Stdin() io.Reader
- func (m *CommandManager) Stdout() io.Writer
- type HelpCommand
- type Manager
- type Registry
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrUnknownCommand = errors.New("unknown command") ErrTooManyArguments = errors.New("too many arguments") ErrShouldExit = errors.New("should exit") ErrNoCommand = errors.New("no command provided") )
View Source
var BUILTINS = make([]Command, 0)
Functions ¶
This section is empty.
Types ¶
type Cmd ¶
type Cmd[T any] struct { ID string Desc string FlagFunc func(m Manager, stored *T, f *flag.FlagSet) error Execute func(m Manager, stored T, args []string) error // contains filtered or unexported fields }
func (*Cmd[T]) Description ¶
type CommandAdder ¶ added in v1.7.2
type CommandDescriptor ¶
type CommandManager ¶ added in v1.7.2
func (*CommandManager) Command ¶ added in v1.7.2
func (m *CommandManager) Command() Command
func (*CommandManager) Input ¶ added in v1.7.2
func (m *CommandManager) Input(question string) (string, error)
func (*CommandManager) Log ¶ added in v1.7.2
func (m *CommandManager) Log(message string)
func (*CommandManager) Logf ¶ added in v1.7.2
func (m *CommandManager) Logf(format string, args ...interface{})
func (*CommandManager) ProtectedInput ¶ added in v1.7.2
func (m *CommandManager) ProtectedInput(question string) (string, error)
func (*CommandManager) Registry ¶ added in v1.7.2
func (m *CommandManager) Registry() Registry
func (*CommandManager) Stderr ¶ added in v1.7.2
func (m *CommandManager) Stderr() io.Writer
func (*CommandManager) Stdin ¶ added in v1.7.2
func (m *CommandManager) Stdin() io.Reader
func (*CommandManager) Stdout ¶ added in v1.7.2
func (m *CommandManager) Stdout() io.Writer
type HelpCommand ¶ added in v1.7.2
func (*HelpCommand) Description ¶ added in v1.7.2
func (c *HelpCommand) Description() string
func (*HelpCommand) Exec ¶ added in v1.7.2
func (c *HelpCommand) Exec(m Manager, args []string) error
func (*HelpCommand) Name ¶ added in v1.7.2
func (c *HelpCommand) Name() string
type Registry ¶ added in v1.6.7
type Registry interface {
Name() string
Which(cmdName string) (Command, bool)
Register(cmd Command)
Unregister(cmdName string) error
Commands() []Command
ExecCommand(args []string) error
ExecCommandOpts(args []string, opts ...func(c *CommandManager)) error
}
func NewRegistry ¶
func NewRegistry(flagsetName string, errorHandling flag.ErrorHandling) Registry
Click to show internal directories.
Click to hide internal directories.