Documentation ¶
Overview ¶
Package cli provides a minimal framework for creating and organizing command line Go applications. cli is designed to be easy to understand and write, the most simple cli application can be written as follows:
func main() { (&cli.App{}).Run(os.Args) }
Of course this application does not do much, so let's make this an actual application:
func main() { app := &cli.App{ Name: "greet", Usage: "say a greeting", Action: func(c *cli.Context) error { println("Greetings") }, } app.Run(os.Args) }
Index ¶
- Variables
- func DefaultAppComplete(c *Context)
- func HandleExitCoder(err error)
- func ShowAppHelp(c *Context) error
- func ShowCommandCompletions(ctx *Context, command string)
- func ShowCommandHelp(ctx *Context, command string) error
- func ShowCompletions(c *Context)
- func ShowSubcommandHelp(c *Context) error
- func ShowVersion(c *Context)
- type ActionFunc
- type AfterFunc
- type App
- func (a *App) Command(name string) *Command
- func (a *App) Run(arguments []string) (err error)
- func (a *App) RunAsSubcommand(ctx *Context) (err error)
- func (a *App) Setup()
- func (a *App) VisibleCategories() []CommandCategory
- func (a *App) VisibleCommands() []*Command
- func (a *App) VisibleFlags() []Flag
- type Args
- type Author
- type BeforeFunc
- type BoolFlag
- type Command
- type CommandCategories
- type CommandCategory
- type CommandNotFoundFunc
- type Context
- func (c *Context) Args() Args
- func (c *Context) Bool(name string) bool
- func (c *Context) Duration(name string) time.Duration
- func (c *Context) FlagNames() []string
- func (c *Context) Float64(name string) float64
- func (c *Context) Float64Slice(name string) []float64
- func (c *Context) Generic(name string) interface{}
- func (c *Context) Int(name string) int
- func (c *Context) Int64(name string) int64
- func (c *Context) Int64Slice(name string) []int64
- func (c *Context) IntSlice(name string) []int
- func (c *Context) IsSet(name string) bool
- func (c *Context) Lineage() []*Context
- func (c *Context) LocalFlagNames() []string
- func (c *Context) NArg() int
- func (c *Context) NumFlags() int
- func (c *Context) Set(name, value string) error
- func (c *Context) String(name string) string
- func (c *Context) StringSlice(name string) []string
- func (c *Context) Uint(name string) uint
- func (c *Context) Uint64(name string) uint64
- type DurationFlag
- type ErrMissingRequired
- type ExitCoder
- type Flag
- type FlagStringFunc
- type FlagsByName
- type Float64Flag
- type Float64Slice
- type Float64SliceFlag
- type Generic
- type GenericFlag
- type Int64Flag
- type Int64Slice
- type Int64SliceFlag
- type IntFlag
- type IntSlice
- type IntSliceFlag
- type IsRequirable
- type MultiError
- type OnUsageErrorFunc
- type Serializeder
- type ShellCompleteFunc
- type StringFlag
- type StringSlice
- type StringSliceFlag
- type Uint64Flag
- type UintFlag
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var AppHelpTemplate = `` /* 951-byte string literal not displayed */
AppHelpTemplate is the text template for the Default help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.
var CommandHelpTemplate = `` /* 358-byte string literal not displayed */
CommandHelpTemplate is the text template for the command help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.
var ErrWriter io.Writer = os.Stderr
ErrWriter is used to write errors to the user. This can be anything implementing the io.Writer interface and defaults to os.Stderr.
var GenerateCompletionFlag = &BoolFlag{ Name: "generate-completion", Hidden: true, }
GenerateCompletionFlag enables completion for all commands and subcommands
var HelpFlag = &BoolFlag{ Name: "help", Aliases: []string{"h"}, Usage: "show help", }
HelpFlag prints the help for all commands and subcommands. Set to nil to disable the flag. The subcommand will still be added unless HideHelp is set to true.
var HelpPrinter helpPrinter = printHelp
HelpPrinter is a function that writes the help output. If not set a default is used. The function signature is: func(w io.Writer, templ string, data interface{})
var InitCompletionFlag = &StringFlag{
Name: "init-completion",
Usage: "generate completion code. Value must be 'bash' or 'zsh'",
}
InitCompletionFlag generates completion code
var OsExiter = os.Exit
OsExiter is the function used when the app exits. If not set defaults to os.Exit.
var SubcommandHelpTemplate = `` /* 411-byte string literal not displayed */
SubcommandHelpTemplate is the text template for the subcommand help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.
var VersionFlag = &BoolFlag{ Name: "version", Aliases: []string{"v"}, Usage: "print the version", }
VersionFlag prints the version for the application
var VersionPrinter = printVersion
VersionPrinter prints the version for the App
Functions ¶
func DefaultAppComplete ¶ added in v1.1.0
func DefaultAppComplete(c *Context)
DefaultAppComplete prints the list of subcommands as the default app completion method
func HandleExitCoder ¶ added in v1.15.0
func HandleExitCoder(err error)
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. If the given error is a MultiError, then this func is called on all members of the Errors slice.
func ShowAppHelp ¶ added in v1.0.0
ShowAppHelp is an action that displays the help.
func ShowCommandCompletions ¶ added in v1.1.0
ShowCommandCompletions prints the custom completions for a given command
func ShowCommandHelp ¶ added in v1.0.0
ShowCommandHelp prints help for the given command
func ShowCompletions ¶ added in v1.1.0
func ShowCompletions(c *Context)
ShowCompletions prints the lists of commands within a given context
func ShowSubcommandHelp ¶ added in v1.1.0
ShowSubcommandHelp prints help for the given subcommand
func ShowVersion ¶ added in v1.0.0
func ShowVersion(c *Context)
ShowVersion prints the version number of the App
Types ¶
type ActionFunc ¶ added in v1.15.0
ActionFunc is the action to execute when no subcommands are specified
type AfterFunc ¶ added in v1.15.0
AfterFunc is an action to execute after any subcommands are run, but after the subcommand has finished it is run even if Action() panics
type App ¶
type App struct { // The name of the program. Defaults to path.Base(os.Args[0]) Name string // Full name of command for help, defaults to Name HelpName string // Description of the program. Usage string // Text to override the USAGE section of help UsageText string // Description of the program argument format. ArgsUsage string // Version of the program Version string // Description of the program Description string // List of commands to execute Commands []*Command // List of flags to parse Flags []Flag // Boolean to enable shell completion commands EnableShellCompletion bool // Boolean to hide built-in help command HideHelp bool // Boolean to hide built-in version flag and the VERSION section of help HideVersion bool // Categories contains the categorized commands and is populated on app startup Categories CommandCategories // An action to execute when the shell completion flag is set ShellComplete ShellCompleteFunc // 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 Before BeforeFunc // An action to execute after any subcommands are run, but after the subcommand has finished // It is run even if Action() panics After AfterFunc // The action to execute when no subcommands are specified Action ActionFunc // Execute this function if the proper command cannot be found CommandNotFound CommandNotFoundFunc // Execute this function if an usage error occurs OnUsageError OnUsageErrorFunc // Compilation date Compiled time.Time // List of all authors who contributed Authors []*Author // Copyright of the binary if any Copyright string // Writer writer to write output to Writer io.Writer // ErrWriter writes error output ErrWriter io.Writer // Other custom info Metadata map[string]interface{} // contains filtered or unexported fields }
App is the main structure of a cli application.
func (*App) Command ¶ added in v1.0.0
Command returns the named command on App. Returns nil if the command does not exist
func (*App) Run ¶
Run is the entry point to the cli app. Parses the arguments slice and routes to the proper flag/args combination
Example ¶
// set args for examples sake os.Args = []string{"greet", "--name", "Jeremy"} app := &App{ Name: "greet", Flags: []Flag{ &StringFlag{Name: "name", Value: "bob", Usage: "a name to say"}, }, Action: func(c *Context) error { fmt.Printf("Hello %v\n", c.String("name")) return nil }, UsageText: "app [first_arg] [second_arg]", Authors: []*Author{{Name: "Oliver Allen", Email: "oliver@toyshop.example.com"}}, } app.Run(os.Args)
Output: Hello Jeremy
Example (AppHelp) ¶
// set args for examples sake os.Args = []string{"greet", "help"} app := &App{ Name: "greet", Version: "0.1.0", Description: "This is how we describe greet the app", Authors: []*Author{ {Name: "Harrison", Email: "harrison@lolwut.com"}, {Name: "Oliver Allen", Email: "oliver@toyshop.com"}, }, Flags: []Flag{ &StringFlag{Name: "name", Value: "bob", Usage: "a name to say"}, }, Commands: []*Command{ { Name: "describeit", Aliases: []string{"d"}, Usage: "use it to see a description", Description: "This is how we describe describeit the function", Action: func(c *Context) error { fmt.Printf("i like to describe things") return nil }, }, }, } app.Run(os.Args)
Output: NAME: greet - A new cli application USAGE: greet [global options] command [command options] [arguments...] VERSION: 0.1.0 DESCRIPTION: This is how we describe greet the app AUTHORS: Harrison <harrison@lolwut.com> Oliver Allen <oliver@toyshop.com> COMMANDS: describeit, d use it to see a description help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --name value a name to say (default: "bob") --help, -h show help (default: false) --version, -v print the version (default: false)
Example (CommandHelp) ¶
// set args for examples sake os.Args = []string{"greet", "h", "describeit"} app := &App{ Name: "greet", Flags: []Flag{ &StringFlag{Name: "name", Value: "bob", Usage: "a name to say"}, }, Commands: []*Command{ { Name: "describeit", Aliases: []string{"d"}, Usage: "use it to see a description", Description: "This is how we describe describeit the function", Action: func(c *Context) error { fmt.Printf("i like to describe things") return nil }, }, }, } app.Run(os.Args)
Output: NAME: greet describeit - use it to see a description USAGE: greet describeit [arguments...] DESCRIPTION: This is how we describe describeit the function
Example (ShellComplete) ¶
// set args for examples sake os.Args = []string{"greet", "--generate-completion"} app := &App{ Name: "greet", EnableShellCompletion: true, Commands: []*Command{ { Name: "describeit", Aliases: []string{"d"}, Usage: "use it to see a description", Description: "This is how we describe describeit the function", Action: func(c *Context) error { fmt.Printf("i like to describe things") return nil }, }, { Name: "next", Usage: "next example", Description: "more stuff to see when generating shell completion", Action: func(c *Context) error { fmt.Printf("the next example") return nil }, }, }, } app.Run(os.Args)
Output: describeit d next help h
Example (Subcommand) ¶
// set args for examples sake os.Args = []string{"say", "hi", "english", "--name", "Jeremy"} app := &App{ Name: "say", Commands: []*Command{ { Name: "hello", Aliases: []string{"hi"}, Usage: "use it to see a description", Description: "This is how we describe hello the function", Subcommands: []*Command{ { Name: "english", Aliases: []string{"en"}, Usage: "sends a greeting in english", Description: "greets someone in english", Flags: []Flag{ &StringFlag{ Name: "name", Value: "Bob", Usage: "Name of the person to greet", }, }, Action: func(c *Context) error { fmt.Println("Hello,", c.String("name")) return nil }, }, }, }, }, } app.Run(os.Args)
Output: Hello, Jeremy
func (*App) RunAsSubcommand ¶ added in v1.1.0
RunAsSubcommand invokes the subcommand given the context, parses ctx.Args() to generate command-specific flags
func (*App) Setup ¶ added in v1.17.0
func (a *App) Setup()
Setup runs initialization code to ensure all data structures are ready for `Run` or inspection prior to `Run`. It is internally called by `Run`, but will return early if setup has already happened.
func (*App) VisibleCategories ¶ added in v1.17.0
func (a *App) VisibleCategories() []CommandCategory
VisibleCategories returns a slice of categories and commands that are Hidden=false
func (*App) VisibleCommands ¶ added in v1.17.0
VisibleCommands returns a slice of the Commands with Hidden=false
func (*App) VisibleFlags ¶ added in v1.16.0
VisibleFlags returns a slice of the Flags with Hidden=false
type Args ¶ added in v1.1.0
type Args interface { // Get returns the nth argument, or else a blank string Get(n int) string // First returns the first argument, or else a blank string First() string // Tail returns the rest of the arguments (not the first one) // or else an empty string slice Tail() []string // Len returns the length of the wrapped slice Len() int // Present checks if there are any arguments present Present() bool // Slice returns a copy of the internal slice Slice() []string }
type BeforeFunc ¶ added in v1.15.0
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
type BoolFlag ¶
type BoolFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value bool DefaultText string Required bool Destination *bool }
BoolFlag is a flag with type bool
func (*BoolFlag) IsRequired ¶
IsRequired implements IsRequirable. Returns true if the flag is required.
type Command ¶
type Command struct { // The name of the command Name string // A list of aliases for the command Aliases []string // A short description of the usage of this command Usage string // Custom text to show on USAGE section of help UsageText string // A longer explanation of how the command works Description string // A short description of the arguments of this command ArgsUsage string // The category the command is part of Category string // The function to call when checking for shell command completions ShellComplete ShellCompleteFunc // An action to execute before any sub-subcommands are run, but after the context is ready // If a non-nil error is returned, no sub-subcommands are run Before BeforeFunc // An action to execute after any subcommands are run, but after the subcommand has finished // It is run even if Action() panics After AfterFunc // The function to call when this command is invoked Action ActionFunc // Execute this function if a usage error occurs. OnUsageError OnUsageErrorFunc // List of child commands Subcommands []*Command // List of flags to parse Flags []Flag // Treat all flags as normal arguments if true SkipFlagParsing bool // Boolean to hide built-in help command HideHelp bool // Boolean to hide this command from help or completion Hidden bool // Full name of command for help, defaults to full command name, including parent commands. HelpName string // contains filtered or unexported fields }
Command is a subcommand for a cli.App.
func (*Command) FullName ¶ added in v1.9.0
FullName returns the full name of the command. For subcommands this ensures that parent commands are part of the command path
func (*Command) Run ¶
Run invokes the command given the context, parses ctx.Args() to generate command-specific flags
func (*Command) VisibleFlags ¶ added in v1.16.0
VisibleFlags returns a slice of the Flags with Hidden=false
type CommandCategories ¶ added in v1.14.0
type CommandCategories interface { // AddCommand adds a command to a category, creating a new category if necessary. AddCommand(category string, command *Command) // Categories returns a copy of the category slice Categories() []CommandCategory }
type CommandCategory ¶ added in v1.14.0
type CommandCategory interface { // Name returns the category name string Name() string // VisibleCommands returns a slice of the Commands with Hidden=false VisibleCommands() []*Command }
CommandCategory is a category containing commands.
type CommandNotFoundFunc ¶ added in v1.15.0
CommandNotFoundFunc is executed if the proper command cannot be found
type Context ¶
Context is a type that is passed through to each Handler action in a cli application. Context can be used to retrieve context-specific args and parsed command-line options.
func NewContext ¶
NewContext creates a new context. For use in when invoking an App or Command action.
func (*Context) Duration ¶ added in v1.3.0
Duration looks up the value of a local DurationFlag, returns 0 if not found
func (*Context) FlagNames ¶ added in v1.3.0
FlagNames returns a slice of flag names used by the this context and all of its parent contexts.
func (*Context) Float64 ¶ added in v1.1.0
Float64 looks up the value of a local Float64Flag, returns 0 if not found
func (*Context) Float64Slice ¶
Float64Slice looks up the value of a local Float64SliceFlag, returns nil if not found
func (*Context) Generic ¶ added in v1.1.0
Generic looks up the value of a local GenericFlag, returns nil if not found
func (*Context) Int64 ¶ added in v1.18.0
Int64 looks up the value of a local Int64Flag, returns 0 if not found
func (*Context) Int64Slice ¶ added in v1.18.0
Int64Slice looks up the value of a local Int64SliceFlag, returns nil if not found
func (*Context) IntSlice ¶ added in v1.0.0
IntSlice looks up the value of a local IntSliceFlag, returns nil if not found
func (*Context) Lineage ¶
Lineage returns *this* context and all of its ancestor contexts in order from child to parent
func (*Context) LocalFlagNames ¶
LocalFlagNames returns a slice of flag names used in this context.
func (*Context) StringSlice ¶ added in v1.0.0
StringSlice looks up the value of a local StringSliceFlag, returns nil if not found
type DurationFlag ¶ added in v1.3.0
type DurationFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value time.Duration DefaultText string Required bool Destination *time.Duration }
DurationFlag is a flag with type time.Duration (see https://golang.org/pkg/time/#ParseDuration)
func (*DurationFlag) Apply ¶ added in v1.3.0
func (f *DurationFlag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*DurationFlag) IsRequired ¶
func (f *DurationFlag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*DurationFlag) IsSetIn ¶
func (f *DurationFlag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*DurationFlag) Names ¶
func (f *DurationFlag) Names() []string
Names returns the names of the flag
func (*DurationFlag) String ¶ added in v1.3.0
func (f *DurationFlag) String() string
String returns a readable representation of this value (for usage defaults)
type ErrMissingRequired ¶
type ErrMissingRequired struct {
// contains filtered or unexported fields
}
func (*ErrMissingRequired) Error ¶
func (e *ErrMissingRequired) Error() string
type ExitCoder ¶ added in v1.15.0
ExitCoder is the interface checked by `App` and `Command` for a custom exit code
type Flag ¶
type Flag interface { fmt.Stringer // Apply Flag settings to the given flag set Apply(*flag.FlagSet) Names() []string }
Flag is a common interface related to parsing flags in cli. For more advanced flag parsing techniques, it is recommended that this interface be implemented.
type FlagStringFunc ¶ added in v1.17.0
FlagStringFunc is used by the help generation to display a flag, which is expected to be a single line.
var FlagStringer FlagStringFunc = stringifyFlag
FlagStringer converts a flag definition to a string. This is used by help to display a flag.
type FlagsByName ¶ added in v1.19.0
type FlagsByName []Flag
FlagsByName is a slice of Flag.
func (FlagsByName) Len ¶ added in v1.19.0
func (f FlagsByName) Len() int
func (FlagsByName) Less ¶ added in v1.19.0
func (f FlagsByName) Less(i, j int) bool
func (FlagsByName) Swap ¶ added in v1.19.0
func (f FlagsByName) Swap(i, j int)
type Float64Flag ¶ added in v1.1.0
type Float64Flag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value float64 DefaultText string Required bool Destination *float64 }
Float64Flag is a flag with type float64
func (*Float64Flag) Apply ¶ added in v1.1.0
func (f *Float64Flag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*Float64Flag) IsRequired ¶
func (f *Float64Flag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*Float64Flag) IsSetIn ¶
func (f *Float64Flag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*Float64Flag) Names ¶
func (f *Float64Flag) Names() []string
Names returns the names of the flag
func (*Float64Flag) String ¶ added in v1.1.0
func (f *Float64Flag) String() string
String returns a readable representation of this value (for usage defaults)
type Float64Slice ¶
type Float64Slice struct {
// contains filtered or unexported fields
}
Float64Slice is an opaque type for []float64 to satisfy flag.Value
func NewFloat64Slice ¶
func NewFloat64Slice(defaults ...float64) *Float64Slice
NewFloat64Slice makes a *Float64Slice with default values
func (*Float64Slice) Serialized ¶
func (f *Float64Slice) Serialized() string
Serialized allows Float64Slice to fulfill Serializeder
func (*Float64Slice) Set ¶
func (f *Float64Slice) Set(value string) error
Set parses the value into a float64 and appends it to the list of values
func (*Float64Slice) String ¶
func (f *Float64Slice) String() string
String returns a readable representation of this value (for usage defaults)
func (*Float64Slice) Value ¶
func (f *Float64Slice) Value() []float64
Value returns the slice of float64s set by this flag
type Float64SliceFlag ¶
type Float64SliceFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value *Float64Slice DefaultText string Required bool }
Float64SliceFlag is a flag with type *Float64Slice
func (*Float64SliceFlag) Apply ¶
func (f *Float64SliceFlag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*Float64SliceFlag) IsRequired ¶
func (f *Float64SliceFlag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*Float64SliceFlag) IsSetIn ¶
func (f *Float64SliceFlag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*Float64SliceFlag) Names ¶
func (f *Float64SliceFlag) Names() []string
Names returns the names of the flag
func (*Float64SliceFlag) String ¶
func (f *Float64SliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
type GenericFlag ¶ added in v1.1.0
type GenericFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value Generic DefaultText string Required bool }
GenericFlag is a flag with type Generic
func (*GenericFlag) Apply ¶ added in v1.1.0
func (f *GenericFlag) Apply(set *flag.FlagSet)
Apply takes the flagset and calls Set on the generic flag with the value provided by the user for parsing by the flag
func (*GenericFlag) IsRequired ¶
func (f *GenericFlag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*GenericFlag) IsSetIn ¶
func (f *GenericFlag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*GenericFlag) Names ¶
func (f *GenericFlag) Names() []string
Names returns the names of the flag
func (*GenericFlag) String ¶ added in v1.1.0
func (f *GenericFlag) String() string
String returns a readable representation of this value (for usage defaults)
type Int64Flag ¶ added in v1.18.0
type Int64Flag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value int64 DefaultText string Required bool Destination *int64 }
Int64Flag is a flag with type int64
func (*Int64Flag) Apply ¶ added in v1.18.0
Apply populates the flag given the flag set and environment
func (*Int64Flag) IsRequired ¶
IsRequired implements IsRequirable. Returns true if the flag is required.
type Int64Slice ¶ added in v1.18.0
type Int64Slice struct {
// contains filtered or unexported fields
}
Int64Slice is an opaque type for []int to satisfy flag.Value
func NewInt64Slice ¶
func NewInt64Slice(defaults ...int64) *Int64Slice
NewInt64Slice makes an *Int64Slice with default values
func (*Int64Slice) Serialized ¶
func (f *Int64Slice) Serialized() string
Serialized allows Int64Slice to fulfill Serializeder
func (*Int64Slice) Set ¶ added in v1.18.0
func (f *Int64Slice) Set(value string) error
Set parses the value into an integer and appends it to the list of values
func (*Int64Slice) String ¶ added in v1.18.0
func (f *Int64Slice) String() string
String returns a readable representation of this value (for usage defaults)
func (*Int64Slice) Value ¶ added in v1.18.0
func (f *Int64Slice) Value() []int64
Value returns the slice of ints set by this flag
type Int64SliceFlag ¶ added in v1.18.0
type Int64SliceFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value *Int64Slice DefaultText string Required bool }
Int64SliceFlag is a flag with type *Int64Slice
func (*Int64SliceFlag) Apply ¶ added in v1.18.0
func (f *Int64SliceFlag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*Int64SliceFlag) IsRequired ¶
func (f *Int64SliceFlag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*Int64SliceFlag) IsSetIn ¶
func (f *Int64SliceFlag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*Int64SliceFlag) Names ¶
func (f *Int64SliceFlag) Names() []string
Names returns the names of the flag
func (*Int64SliceFlag) String ¶ added in v1.18.0
func (f *Int64SliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
type IntFlag ¶
type IntFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value int DefaultText string Required bool Destination *int }
IntFlag is a flag with type int
func (*IntFlag) IsRequired ¶
IsRequired implements IsRequirable. Returns true if the flag is required.
type IntSlice ¶ added in v1.0.0
type IntSlice struct {
// contains filtered or unexported fields
}
IntSlice wraps an []int to satisfy flag.Value
func NewIntSlice ¶
NewIntSlice makes an *IntSlice with default values
func (*IntSlice) Serialized ¶
Serialized allows IntSlice to fulfill Serializeder
func (*IntSlice) Set ¶ added in v1.0.0
Set parses the value into an integer and appends it to the list of values
type IntSliceFlag ¶ added in v1.0.0
type IntSliceFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value *IntSlice DefaultText string Required bool }
IntSliceFlag is a flag with type *IntSlice
func (*IntSliceFlag) Apply ¶ added in v1.0.0
func (f *IntSliceFlag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*IntSliceFlag) IsRequired ¶
func (f *IntSliceFlag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*IntSliceFlag) IsSetIn ¶
func (f *IntSliceFlag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*IntSliceFlag) Names ¶
func (f *IntSliceFlag) Names() []string
Names returns the names of the flag
func (*IntSliceFlag) String ¶ added in v1.0.0
func (f *IntSliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
type IsRequirable ¶
IsRequirable is a common interface for flags that might be required. This is a separate interface from Flag so that it can be an optional interface on Flag
type MultiError ¶ added in v1.7.1
MultiError is an error that wraps multiple errors.
type OnUsageErrorFunc ¶ added in v1.15.0
OnUsageErrorFunc is executed if an usage error occurs. This is useful for displaying customized usage error messages. This function is able to replace the original error messages. If this function is not set, the "Incorrect usage" is displayed and the execution is interrupted.
type Serializeder ¶
type Serializeder interface {
Serialized() string
}
Serializeder is used to circumvent the limitations of flag.FlagSet.Set
type ShellCompleteFunc ¶
type ShellCompleteFunc func(*Context)
ShellCompleteFunc is an action to execute when the shell completion flag is set
type StringFlag ¶
type StringFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value string DefaultText string Required bool Destination *string }
StringFlag is a flag with type string
func (*StringFlag) Apply ¶
func (f *StringFlag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*StringFlag) IsRequired ¶
func (f *StringFlag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*StringFlag) IsSetIn ¶
func (f *StringFlag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*StringFlag) Names ¶
func (f *StringFlag) Names() []string
Names returns the names of the flag
func (*StringFlag) String ¶
func (f *StringFlag) String() string
String returns a readable representation of this value (for usage defaults)
type StringSlice ¶ added in v1.0.0
type StringSlice struct {
// contains filtered or unexported fields
}
StringSlice wraps a []string to satisfy flag.Value
func NewStringSlice ¶
func NewStringSlice(defaults ...string) *StringSlice
NewStringSlice creates a *StringSlice with default values
func (*StringSlice) Serialized ¶
func (f *StringSlice) Serialized() string
Serialized allows StringSlice to fulfill Serializeder
func (*StringSlice) Set ¶ added in v1.0.0
func (f *StringSlice) Set(value string) error
Set appends the string value to the list of values
func (*StringSlice) String ¶ added in v1.0.0
func (f *StringSlice) String() string
String returns a readable representation of this value (for usage defaults)
func (*StringSlice) Value ¶ added in v1.0.0
func (f *StringSlice) Value() []string
Value returns the slice of strings set by this flag
type StringSliceFlag ¶ added in v1.0.0
type StringSliceFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value *StringSlice DefaultText string Required bool }
StringSliceFlag is a flag with type *StringSlice
func (*StringSliceFlag) Apply ¶ added in v1.0.0
func (f *StringSliceFlag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*StringSliceFlag) IsRequired ¶
func (f *StringSliceFlag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*StringSliceFlag) IsSetIn ¶
func (f *StringSliceFlag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*StringSliceFlag) Names ¶
func (f *StringSliceFlag) Names() []string
Names returns the names of the flag
func (*StringSliceFlag) String ¶ added in v1.0.0
func (f *StringSliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
type Uint64Flag ¶ added in v1.18.0
type Uint64Flag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value uint64 DefaultText string Required bool Destination *uint64 }
Uint64Flag is a flag with type uint64
func (*Uint64Flag) Apply ¶ added in v1.18.0
func (f *Uint64Flag) Apply(set *flag.FlagSet)
Apply populates the flag given the flag set and environment
func (*Uint64Flag) IsRequired ¶
func (f *Uint64Flag) IsRequired() bool
IsRequired implements IsRequirable. Returns true if the flag is required.
func (*Uint64Flag) IsSetIn ¶
func (f *Uint64Flag) IsSetIn(c *Context) bool
IsSetIn implements IsRequirable. Returns true if the flag is set in the given context.
func (*Uint64Flag) Names ¶
func (f *Uint64Flag) Names() []string
Names returns the names of the flag
func (*Uint64Flag) String ¶ added in v1.18.0
func (f *Uint64Flag) String() string
String returns a readable representation of this value (for usage defaults)
type UintFlag ¶ added in v1.18.0
type UintFlag struct { Name string Aliases []string Usage string EnvVars []string Hidden bool Value uint DefaultText string Required bool Destination *uint }
UintFlag is a flag with type uint
func (*UintFlag) Apply ¶ added in v1.18.0
Apply populates the flag given the flag set and environment
func (*UintFlag) IsRequired ¶
IsRequired implements IsRequirable. Returns true if the flag is required.