command

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

type Argument struct {
	// The name of the argument
	Name string
	// Help associated with the argument. Will be
	// displayed by the help command.
	Help string
	// Wheter the argument is optional
	Optional bool
}

type Cmd struct {
	// Name is the name of the command, case sensitive.
	Name string
	// Help is a short, one line help string displayed by
	// the help command when listing all the commands.
	Help string
	// LongHelp is a long, potentially multi-line, help message
	// displayed when using the help command for a specific
	// command (e.g. myprogram help somecommand)
	LongHelp string
	// Usage is displayed when showing the help for a specific
	// command. The program name (os.Args[0]) and the command
	// name are prepended to it when displaying it to the user,
	// as well as any arguments defined in the Args field.
	// (e.g. Usage = <something> shows "usage: myprog subcmd <something>")
	Usage string
	// Args accepted by the command. If nil, no argument validation
	// is performed. To define a command which accepts no arguments and
	// errors when arguments are passed, set this field to NoArgs.
	// See the Argument and Args types for more information.
	Args []*Argument
	// Func is the handler function for the command. The function must take either
	// one or two arguments. The first one must be an *Args, which is
	// used to access non-flag arguments.
	// If the function accepts a second argument it must
	// be of the exact same type than the value provided in the Options field.
	// Handler functions might optionally return an error value.
	Func interface{}
	// Options might be either nil or a pointer to a struct type. Command flags
	// will be generated from this struct, in the same order as the fields are
	// defined. The current value of the field will be used as the default value
	// for the flag. Each field might also include two struct tags:
	//
	//  - name: The name of the flag. If not present, it will default to the field name in lowercase.
	//  - help: The short help shown the flag package for the given field.
	Options interface{}
}

type CommandHelp struct {
	Name     string  `json:"name"`
	Help     string  `json:"help"`
	LongHelp string  `json:"long_help"`
	Usage    string  `json:"usage"`
	Flags    []*Flag `json:"flags"`
}

type CommandProvider interface {
	Commands() ([]*Cmd, error)
}

type Flag struct {
	Name    string `json:"name"`
	Help    string `json:"help"`
	Type    string `json:"type"`
	Default string `json:"default"`
}

type Help struct {
	Name     string         `json:"name"`
	Flags    []*Flag        `json:"flags"`
	Commands []*CommandHelp `json:"commands"`
}

type Options struct {
	// Options represents global options which the application
	// needs to handle before running any commands. If this field
	// is non-nil and Handler is also non-nil, its first argument
	// must match the type of this field.
	//
	// Optionally, the value in this field might implement the
	// CommandProvider interface. In that case, its Commands function
	// is called after BeforeFunc and before Func.
	Options interface{}
	// Func is called after the command to execute is determined but before
	// executing it.
	Func func(*Cmd, *Options) error
	// BeforeFunc must follow the same characteristics of Func, except it
	// can't take an optional *Cmd parameter.
	//
	// BeforeFunc is called before the command to execute is determined, so
	// it can be used to conditionally set up additional commands.
	BeforeFunc func(*Options) error
}

type UnknownCommandError string