commando

Documentation

Index

• Variables
• func ArgError(err error) error
• func NewFlagSet(name string) *flag.FlagSet
• func Register(fs *flag.FlagSet, desc string, f CommandFunc)
• func Run()
• type CommandFunc

Variables

var Output = io.Writer(os.Stderr)

Output is the Writer where help and errors are printed with regards to command line parsing. It is os.Stderr by default. It should be set before Run.

Functions

func ArgError

func ArgError(err error) error

ArgError is used to wrap an error returned from CommandFunc, in order to signal that the error should be regarded as a command line validation issue. If the error returned by CommandFunc is wrapped like this, help will be printed.

func NewFlagSet

func NewFlagSet(name string) *flag.FlagSet

NewFlagSet creates a new FlagSet with ContinueOnError, and Usage set directly to PrintDefaults.

func Register

func Register(fs *flag.FlagSet, desc string, f CommandFunc)

Register registers the given FlagSet as a command. The command name is fs.Name(). fs should preferably be made by commando.NewFlagSet, but otherwise it should be created with flag.ContinueOnError.

func Run

func Run()

Run will parse the command line flags and run the appropriate command. It will exit the application if a problem occurs, and print help and errors to Output if needed. The usage line is printed by Run, not Usage; keep this in mind when setting Usage.

Types

type CommandFunc

type CommandFunc func() error