package
1.1.4
Repository: https://github.com/getevo/evo.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

DefaultAppComplete prints the list of subcommands as the default app completion method.
No description provided by the author
Exit wraps a message and exit code into an error, which by default is handled with a call to os.Exit during default error handling.
HandleAction attempts to figure out which Action signature was used.
HandleExitCoder handles errors implementing ExitCoder by printing their message and calling OsExiter with the given exit code.
NewApp creates a new cli Application with some reasonable defaults for Name, Usage, Version and Action.
NewContext creates a new context.
NewExitError calls Exit to create a new ExitCoder.
NewFloat64Slice makes a *Float64Slice with default values.
NewInt64Slice makes an *Int64Slice with default values.
NewIntSlice makes an *IntSlice with default values.
NewStringSlice creates a *StringSlice with default values.
Timestamp constructor.
ShowAppHelp is an action that displays the help.
ShowAppHelpAndExit - Prints the list of subcommands for the app and exits with exit code.
ShowCommandCompletions prints the custom completions for a given command.
ShowCommandHelp prints help for the given command.
ShowCommandHelpAndExit - exits with code after showing help.
ShowCompletions prints the lists of commands within a given context.
ShowSubcommandHelp prints help for the given subcommand.
ShowVersion prints the version number of the App.

# Variables

AppHelpTemplate is the text template for the Default help topic.
BashCompletionFlag enables bash-completion for all commands and subcommands.
CommandHelpTemplate is the text template for the command help topic.
ErrWriter is used to write errors to the user.
No description provided by the author
FlagEnvHinter annotates flag help message with the environment variable details.
FlagFileHinter annotates flag help message with the environment variable details.
FlagNamePrefixer converts a full flag name and its placeholder into the help message flag prefix.
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.
HelpPrinterCustom is a function that writes the help output.
No description provided by the author
OsExiter is the function used when the app exits.
SubcommandHelpTemplate is the text template for the subcommand help topic.
VersionFlag prints the version for the application.
VersionPrinter prints the version for the App.

# Structs

App is the main structure of a cli application.
Author represents someone who has contributed to a cli project.
BoolFlag is a flag with type bool.
Command is a subcommand for a cli.App.
Context is a type that is passed through to each Handler action in a cli application.
DurationFlag is a flag with type time.Duration (see https://golang.org/pkg/time/#ParseDuration).
Float64Flag is a flag with type float64.
Float64Slice wraps []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 wraps []int64 to satisfy flag.Value.
Int64SliceFlag is a flag with type *Int64Slice.
IntFlag is a flag with type int.
IntSlice wraps []int to satisfy flag.Value.
IntSliceFlag is a flag with type *IntSlice.
No description provided by the author
StringFlag is a flag with type string.
StringSlice wraps a []string to satisfy flag.Value.
StringSliceFlag is a flag with type *StringSlice.
Timestamp wrap to satisfy golang's flag interface.
TimestampFlag is a flag with type time.
Uint64Flag is a flag with type uint64.
UintFlag is a flag with type uint.

# Interfaces

No description provided by the author
CommandCategories interface allows for category manipulation.
CommandCategory is a category containing commands.
DocGenerationFlag is an interface that allows documentation generation for the flag.
ErrorFormatter is the interface that will suitably format the error output.
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.
RequiredFlag is an interface that allows us to mark flags as required it allows flags required flags to be backwards compatible with the Flag interface.
Serializer is used to circumvent the limitations of flag.FlagSet.Set.

# Type aliases

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.
BashCompleteFunc is an action to execute when the shell completion flag is set.
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.
No description provided by the author
No description provided by the author
ExitErrHandlerFunc is executed if provided in order to handle exitError values returned by Actions and Before/After functions.
FlagEnvHintFunc is used by the default FlagStringFunc to annotate flag help with the environment variable details.
FlagFileHintFunc is used by the default FlagStringFunc to annotate flag help with the file path details.
FlagNamePrefixFunc is used by the default FlagStringFunc to create prefix text for a flag's full name.
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.
OnUsageErrorFunc is executed if an usage error occurs.