scli

type ArgsValidator func(args []string) error

type Command struct {
	// Usage is a one liner usage message. First word of Usage is used for the Command's name.
	// Required for sub-commands.
	// Recommend syntax is:
	//
	//     cmd [flags] subcmd [flags] <required> [<optional> ...]
	Usage string

	// Aliases is a slice of alternate names that can be used for a sub command instead of the first word of usage.
	// Optional.
	Aliases []string

	// ShortHelp is a short description that is displayed in the global help -h output.
	// Optional, but recommended.
	ShortHelp string

	// LongHelp is a longer description that is displayed int the '<this-command> -h' output.
	// If not provided ShortHelp will be used in its place. Optional.
	LongHelp string

	// Subcommands is a slice of commands supported by Command.
	// Subcommands are optional and only needed if you application needs multiple commands.
	Subcommands []*Command

	// TODO
	UsageFunc func(c *Command) string

	// FlagSet for this command. Optional, but if none is provided,
	// an empty FlagSet will be defined to ensure -h works as expected.
	FlagSet *flag.FlagSet

	// ArgsValidator provides a validation function for arguments. There are multiple builtin validators as the
	// XArgs functions in this package.
	// Any error returned by ArgsValidator gets wrapped by an ErrInvalidArguments then is returned by Run or ParseAndRun.
	// When ArgsValidator returns an error the commands usage will be printed as well as the body of the error message.
	ArgsValidator ArgsValidator

	// Exec is the function that does the actual work, most Command's will implement this, unless they are just a
	// namespace for Subcommands.
	// The error returned by Exec will be bubble up and be returned by Run and ParseAndRun.
	// If flag.ErrHelp or ErrInvalidArguments is returned the commands usage will be printed to the output.
	Exec func(ctx context.Context, args []string) error
	// contains filtered or unexported fields
}

type NoExecError struct {
	Command *Command
}