Console

Exit wraps a message and exit code into an ExitCoder suitable for handling by HandleExitCoder.

HandleExitCoder checks if the error fulfills the ExitCoder interface, and if so prints the error to stderr (if it is non-empty) and calls OsExiter with the given exit code.

NewContext creates a new context.

NewFloat64Slice makes a *Float64Slice with default values.

NewInt64Slice makes an *Int64Slice with default values.

NewIntSlice makes an *IntSlice with default values.

NewStringMap creates a *StringMap with default values.

NewStringSlice creates a *StringSlice with default values.

ShowAppHelp is an action that displays the help.

ShowAppHelpAction is an action that displays the global help or for the specified command.

ShowCommandHelp prints help for the given command.

ShowVersion prints the version number of the App.

FlagParsingNormal sets parsing to a normal mode, complete parsing of all flags found after command name.

FlagParsingSkipped sets parsing to a mode where parsing stops just after the command name.

FlagParsingSkippedAfterFirstArg sets parsing to a hybrid mode where parsing continues after the command name until an argument is found.

AppHelpTemplate is the text template for the Default help topic.

CategoryHelpTemplate is the text template for the category help topic.

CommandHelpTemplate is the text template for the command help topic.

CompletionTemplates holds our shell completions templates.

FlagStringer converts a flag definition to a string.

HelpFlag prints the help for all commands and subcommands.

HelpPrinter is a function that writes the help output.

OsExiter is the function used when the app exits.

VersionFlag prints the version for the application.

VersionPrinter prints the version for the App.

Application is the main structure of a cli application.

BoolFlag is a flag with type bool.

Command is a subcommand for a console.App.

Context is a type that is passed through to each Handler action in a cli application.

ContextPredictor determines what terms can follow a command or a flag It is used for autocompletion, given the last word in the already completed command line, what words can complete it.

DurationFlag is a flag with type time.Duration (see https://golang.org/pkg/time/#ParseDuration).

Float64Flag is a flag with type float64.

Float64Slice is an opaque type for []float64 to satisfy flag.Value.

Float64SliceFlag is a flag with type *Float64Slice.

GenericFlag is a flag with type Generic.

Int64Flag is a flag with type int64.

Int64Slice is an opaque type for []int to satisfy flag.Value.

Int64SliceFlag is a flag with type *Int64Slice.

IntFlag is a flag with type int.

IntSlice wraps an []int to satisfy flag.Value.

IntSliceFlag is a flag with type *IntSlice.

StringFlag is a flag with type string.

StringMap wraps a map[string]string to satisfy flag.Value.

StringMapFlag is a flag with type *StringMap.

StringSlice wraps a []string to satisfy flag.Value.

StringSliceFlag is a flag with type *StringSlice.

Uint64Flag is a flag with type uint64.

UintFlag is a flag with type uint.

CommandCategory is a category containing commands.

ExitCoder is the interface checked by `App` and `Command` for a custom exit code.

Flag is a common interface related to parsing flags in cli.

Generic is a generic parseable type identified by a specific flag.

MultiError is an error that wraps multiple errors.

Serializeder is used to circumvent the limitations of flag.FlagSet.Set.

ActionFunc is the action to execute when no subcommands are specified.

AfterFunc is an action to execute after any subcommands are run, but after the subcommand has finished it is run even if Action() panics.

BeforeFunc is an action to execute before any subcommands are run, but after the context is ready if a non-nil error is returned, no subcommands are run.

CommandNotFoundFunc is executed if the proper command cannot be found.

DescriptionFunc is used by the help generation to display a description when its computation is intensive or needs runtime information.

FlagParsingMode defines how arguments and flags parsing is done.

FlagsByName is a slice of Flag.

FlagStringFunc is used by the help generation to display a flag, which is expected to be a single line.

ShellCompleteFunc is an action to execute when the shell completion flag is set.