commands

Documentation

Index

• func GetCommands() []*cli.Command
• func RegisterCommand(name CommandName, command Command, opts *CommandOpts) error
• type Command
• type CommandName
• type CommandOpts

Functions

func GetCommands

func GetCommands() []*cli.Command

GetCommands returns the registered commands

func RegisterCommand

func RegisterCommand(name CommandName, command Command, opts *CommandOpts) error

RegisterCommand registers a command

Types

type Command

type Command interface {
	Name() CommandName
	Aliases() []string
	Usage() string
	Subcommands() []*cli.Command
	Flags() []cli.Flag
	Action(c *cli.Context) error
}

Command is the interface that all commands must implement

type CommandName

type CommandName string

CommandName is the name of the command

type CommandOpts

type CommandOpts struct {
	// Treat all flags as normal arguments if true
	SkipFlagParsing bool
}

CommandOpts is the options for a command