import "github.com/urfave/cli"
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 {
fmt.Println("Greetings")
return nil
},
}
app.Run(os.Args)
}
app.go args.go category.go cli.go command.go context.go docs.go errors.go fish.go flag.go flag_bool.go flag_duration.go flag_float64.go flag_float64_slice.go flag_generic.go flag_int.go flag_int64.go flag_int64_slice.go flag_int_slice.go flag_path.go flag_string.go flag_string_slice.go flag_timestamp.go flag_uint.go flag_uint64.go funcs.go help.go parse.go sort.go template.go
var AppHelpTemplate = "" /* 1056 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 = "" /* 406 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.
ErrWriter is used to write errors to the user. This can be anything implementing the io.Writer interface and defaults to os.Stderr.
var FishCompletionTemplate = "" /* 360 byte string literal not displayed */
var HelpPrinter helpPrinter = printHelpHelpPrinter is a function that writes the help output. If not set explicitly, this calls HelpPrinterCustom using only the default template functions.
If custom logic for printing help is required, this function can be overridden. If the ExtraInfo field is defined on an App, this function should not be modified, as HelpPrinterCustom will be used directly in order to capture the extra information.
var HelpPrinterCustom helpPrinterCustom = printHelpCustomHelpPrinterCustom is a function that writes the help output. It is used as the default implementation of HelpPrinter, and may be called directly if the ExtraInfo field is set on an App.
var MarkdownDocTemplate = "" /* 146 byte string literal not displayed */+ "```" + ` {{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + ` {{ end }}{{ if .App.UsageText }} # DESCRIPTION {{ .App.UsageText }} {{ end }} **Usage**: ` + "```" + ` {{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] ` + "```" + "" /* 182 byte string literal not displayed */
OsExiter is the function used when the app exits. If not set defaults to os.Exit.
var SubcommandHelpTemplate = "" /* 602 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 VersionPrinter = printVersionVersionPrinter prints the version for the App
DefaultAppComplete prints the list of subcommands as the default app completion method
HandleAction attempts to figure out which Action signature was used. If it's an ActionFunc or a func with the legacy signature for Action, the func is run!
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 and calls OsExiter with the last exit code.
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
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
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 bash completion commands
EnableBashCompletion 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
// An action to execute when the shell completion flag is set
BashComplete BashCompleteFunc
// 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
// Execute this function to handle ExitErrors. If not provided, HandleExitCoder is provided to
// function as a default, so this is optional.
ExitErrHandler ExitErrHandlerFunc
// Other custom info
Metadata map[string]interface{}
// Carries a function which returns app specific info.
ExtraInfo func() map[string]string
// CustomAppHelpTemplate the text template for app help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomAppHelpTemplate string
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandling bool
// contains filtered or unexported fields
}App is the main structure of a cli application. It is recommended that an app be created with the cli.NewApp() function
NewApp creates a new cli Application with some reasonable defaults for Name, Usage, Version and Action.
Command returns the named command on App. Returns nil if the command does not exist
Run is the entry point to the cli app. Parses the arguments slice and routes to the proper flag/args combination
Code:
// 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
Code:
// 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)
Code:
// set args for examples sake
// set args for examples sake
os.Args = []string{"greet", "--generate-bash-completion"}
app := &App{
Name: "greet",
EnableBashCompletion: 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
Code:
// 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
Code:
app := App{}
app.Name = "greet"
_ = app.Run([]string{"greet"})
Output:
NAME: greet - A new cli application USAGE: greet [global options] command [command options] [arguments...] COMMANDS: help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --help, -h show help (default: false)
Code:
// 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
Code:
app := &App{
Name: "greet",
Commands: []*Command{
{
Name: "describeit",
Aliases: []string{"d"},
Usage: "use it to see a description",
Description: "This is how we describe describeit the function",
},
},
}
_ = app.Run([]string{"greet", "describeit"})
Output:
NAME: greet describeit - use it to see a description USAGE: greet describeit [command options] [arguments...] DESCRIPTION: This is how we describe describeit the function OPTIONS: --help, -h show help (default: false)
Code:
// set args for examples sake
os.Args = []string{"greet", "--generate-bash-completion"}
_ = os.Setenv("_CLI_ZSH_AUTOCOMPLETE_HACK", "1")
app := NewApp()
app.Name = "greet"
app.EnableBashCompletion = true
app.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 bash completion",
Action: func(c *Context) error {
fmt.Printf("the next example")
return nil
},
},
}
_ = app.Run(os.Args)
Output:
describeit:use it to see a description d:use it to see a description next:next example help:Shows a list of commands or help for one command h:Shows a list of commands or help for one command
RunAndExitOnError calls .Run() and exits non-zero if an error was returned
Deprecated: instead you should return an error that fulfills cli.ExitCoder to cli.App.Run. This will cause the application to exit with the given eror code in the cli.ExitCoder
RunAsSubcommand invokes the subcommand given the context, parses ctx.Args() to generate command-specific flags
RunContext is like Run except it takes a Context that will be passed to its commands and sub-commands. Through this, you can propagate timeouts and cancellation requests
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.
ToFishCompletion creates a fish completion string for the `*App` The function errors if either parsing or writing of the string fails.
ToMan creates a man page string for the `*App` The function errors if either parsing or writing of the string fails.
ToMarkdown creates a markdown string for the `*App` The function errors if either parsing or writing of the string fails.
func (a *App) VisibleCategories() []CommandCategory
VisibleCategories returns a slice of categories and commands that are Hidden=false
VisibleCommands returns a slice of the Commands with Hidden=false
VisibleFlags returns a slice of the Flags with Hidden=false
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
}Author represents someone who has contributed to a cli project.
String makes Author comply to the Stringer interface, to allow an easy print in the templating process
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
type BoolFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value bool
DefaultText string
Destination *bool
HasBeenSet bool
}BoolFlag is a flag with type bool
Apply populates the flag given the flag set and environment
GetUsage returns the usage string for the flag
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
IsRequired returns whether or not the flag is required
IsSet returns whether or not the flag has been set through env or file
Names returns the names of the flag
String returns a readable representation of this value (for usage defaults)
TakesValue returns true of the flag takes a value, otherwise false
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 bash command completions
BashComplete BashCompleteFunc
// 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
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandling bool
// Full name of command for help, defaults to full command name, including parent commands.
HelpName string
// CustomHelpTemplate 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.
CustomHelpTemplate string
// contains filtered or unexported fields
}Command is a subcommand for a cli.App.
FullName returns the full name of the command. For subcommands this ensures that parent commands are part of the command path
HasName returns true if Command.Name matches given name
Names returns the names including short names and aliases.
Run invokes the command given the context, parses ctx.Args() to generate command-specific flags
VisibleFlags returns a slice of the Flags with Hidden=false
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
}CommandCategories interface allows for category manipulation
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.
CommandNotFoundFunc is executed if the proper command cannot be found
func (c CommandsByName) Len() int
func (c CommandsByName) Less(i, j int) bool
func (c CommandsByName) Swap(i, j int)
type Context struct {
context.Context
App *App
Command *Command
// contains filtered or unexported fields
}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.
NewContext creates a new context. For use in when invoking an App or Command action.
Args returns the command line arguments associated with the context.
Bool looks up the value of a local BoolFlag, returns false if not found
Duration looks up the value of a local DurationFlag, returns 0 if not found
FlagNames returns a slice of flag names used by the this context and all of its parent contexts.
Float64 looks up the value of a local Float64Flag, returns 0 if not found
Float64Slice looks up the value of a local Float64SliceFlag, returns nil if not found
Generic looks up the value of a local GenericFlag, returns nil if not found
Int looks up the value of a local IntFlag, returns 0 if not found
Int64 looks up the value of a local Int64Flag, returns 0 if not found
Int64Slice looks up the value of a local Int64SliceFlag, returns nil if not found
IntSlice looks up the value of a local IntSliceFlag, returns nil if not found
IsSet determines if the flag was actually set
Lineage returns *this* context and all of its ancestor contexts in order from child to parent
LocalFlagNames returns a slice of flag names used in this context.
NArg returns the number of the command line arguments.
NumFlags returns the number of flags set
Path looks up the value of a local PathFlag, returns "" if not found
Set sets a context flag to a value.
String looks up the value of a local StringFlag, returns "" if not found
StringSlice looks up the value of a local StringSliceFlag, returns nil if not found
Timestamp gets the timestamp from a flag name
Uint looks up the value of a local UintFlag, returns 0 if not found
Uint64 looks up the value of a local Uint64Flag, returns 0 if not found
Value returns the value of the flag corresponding to `name`
type DocGenerationFlag interface {
Flag
// TakesValue returns true if the flag takes a value, otherwise false
TakesValue() bool
// GetUsage returns the usage string for the flag
GetUsage() string
// GetValue returns the flags value as string representation and an empty
// string if the flag takes no value at all.
GetValue() string
}DocGenerationFlag is an interface that allows documentation generation for the flag
type DurationFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value time.Duration
DefaultText string
Destination *time.Duration
HasBeenSet bool
}DurationFlag is a flag with type time.Duration (see https://golang.org/pkg/time/#ParseDuration)
func (f *DurationFlag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f *DurationFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *DurationFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *DurationFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *DurationFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *DurationFlag) Names() []string
Names returns the names of the flag
func (f *DurationFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *DurationFlag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
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
Exit wraps a message and exit code into an ExitCoder suitable for handling by HandleExitCoder
NewExitError makes a new *exitError
ExitErrHandlerFunc is executed if provided in order to handle exitError values returned by Actions and Before/After functions.
type Flag interface {
fmt.Stringer
// Apply Flag settings to the given flag set
Apply(*flag.FlagSet) error
Names() []string
IsSet() bool
}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.
BashCompletionFlag enables bash-completion for all commands and subcommands
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 VersionFlag Flag = &BoolFlag{ Name: "version", Aliases: []string{"v"}, Usage: "print the version", }
VersionFlag prints the version for the application
FlagEnvHintFunc is used by the default FlagStringFunc to annotate flag help with the environment variable details.
var FlagEnvHinter FlagEnvHintFunc = withEnvHint
FlagEnvHinter annotates flag help message with the environment variable details. This is used by the default FlagStringer.
FlagFileHintFunc is used by the default FlagStringFunc to annotate flag help with the file path details.
var FlagFileHinter FlagFileHintFunc = withFileHint
FlagFileHinter annotates flag help message with the environment variable details. This is used by the default FlagStringer.
FlagNamePrefixFunc is used by the default FlagStringFunc to create prefix text for a flag's full name.
var FlagNamePrefixer FlagNamePrefixFunc = prefixedNames
FlagNamePrefixer converts a full flag name and its placeholder into the help message flag prefix. This is used by the default FlagStringer.
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.
FlagsByName is a slice of Flag.
func (f FlagsByName) Len() int
func (f FlagsByName) Less(i, j int) bool
func (f FlagsByName) Swap(i, j int)
type Float64Flag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value float64
DefaultText string
Destination *float64
HasBeenSet bool
}Float64Flag is a flag with type float64
func (f *Float64Flag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f *Float64Flag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *Float64Flag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *Float64Flag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *Float64Flag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *Float64Flag) Names() []string
Names returns the names of the flag
func (f *Float64Flag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *Float64Flag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
type Float64Slice struct {
// contains filtered or unexported fields
}Float64Slice wraps []float64 to satisfy flag.Value
func NewFloat64Slice(defaults ...float64) *Float64Slice
NewFloat64Slice makes a *Float64Slice with default values
func (f *Float64Slice) Get() interface{}
Get returns the slice of float64s set by this flag
func (f *Float64Slice) Serialize() string
Serialize allows Float64Slice to fulfill Serializer
func (f *Float64Slice) Set(value string) error
Set parses the value into a float64 and appends it to the list of values
func (f *Float64Slice) String() string
String returns a readable representation of this value (for usage defaults)
func (f *Float64Slice) Value() []float64
Value returns the slice of float64s set by this flag
type Float64SliceFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value *Float64Slice
DefaultText string
HasBeenSet bool
}Float64SliceFlag is a flag with type *Float64Slice
func (f *Float64SliceFlag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f *Float64SliceFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *Float64SliceFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *Float64SliceFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *Float64SliceFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *Float64SliceFlag) Names() []string
Names returns the names of the flag
func (f *Float64SliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *Float64SliceFlag) TakesValue() bool
TakesValue returns true if the flag takes a value, otherwise false
Generic is a generic parseable type identified by a specific flag
type GenericFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
TakesFile bool
Value Generic
DefaultText string
HasBeenSet bool
}GenericFlag is a flag with type Generic
func (f GenericFlag) Apply(set *flag.FlagSet) error
Apply takes the flagset and calls Set on the generic flag with the value provided by the user for parsing by the flag
func (f *GenericFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *GenericFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *GenericFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *GenericFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *GenericFlag) Names() []string
Names returns the names of the flag
func (f *GenericFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *GenericFlag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
type Int64Flag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value int64
DefaultText string
Destination *int64
HasBeenSet bool
}Int64Flag is a flag with type int64
Apply populates the flag given the flag set and environment
GetUsage returns the usage string for the flag
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
IsRequired returns whether or not the flag is required
IsSet returns whether or not the flag has been set through env or file
Names returns the names of the flag
String returns a readable representation of this value (for usage defaults)
TakesValue returns true of the flag takes a value, otherwise false
type Int64Slice struct {
// contains filtered or unexported fields
}Int64Slice wraps []int64 to satisfy flag.Value
func NewInt64Slice(defaults ...int64) *Int64Slice
NewInt64Slice makes an *Int64Slice with default values
func (i *Int64Slice) Get() interface{}
Get returns the slice of ints set by this flag
func (i *Int64Slice) Serialize() string
Serialize allows Int64Slice to fulfill Serializer
func (i *Int64Slice) Set(value string) error
Set parses the value into an integer and appends it to the list of values
func (i *Int64Slice) String() string
String returns a readable representation of this value (for usage defaults)
func (i *Int64Slice) Value() []int64
Value returns the slice of ints set by this flag
type Int64SliceFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value *Int64Slice
DefaultText string
HasBeenSet bool
}Int64SliceFlag is a flag with type *Int64Slice
func (f *Int64SliceFlag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f Int64SliceFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *Int64SliceFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *Int64SliceFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *Int64SliceFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *Int64SliceFlag) Names() []string
Names returns the names of the flag
func (f *Int64SliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *Int64SliceFlag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
type IntFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value int
DefaultText string
Destination *int
HasBeenSet bool
}IntFlag is a flag with type int
Apply populates the flag given the flag set and environment
GetUsage returns the usage string for the flag
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
IsRequired returns whether or not the flag is required
IsSet returns whether or not the flag has been set through env or file
Names returns the names of the flag
String returns a readable representation of this value (for usage defaults)
TakesValue returns true of the flag takes a value, otherwise false
type IntSlice struct {
// contains filtered or unexported fields
}IntSlice wraps []int to satisfy flag.Value
NewIntSlice makes an *IntSlice with default values
Get returns the slice of ints set by this flag
Serialize allows IntSlice to fulfill Serializer
Set parses the value into an integer and appends it to the list of values
TODO: Consistently have specific Set function for Int64 and Float64 ? SetInt directly adds an integer to the list of values
String returns a readable representation of this value (for usage defaults)
Value returns the slice of ints set by this flag
type IntSliceFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value *IntSlice
DefaultText string
HasBeenSet bool
}IntSliceFlag is a flag with type *IntSlice
func (f *IntSliceFlag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f IntSliceFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *IntSliceFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *IntSliceFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *IntSliceFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *IntSliceFlag) Names() []string
Names returns the names of the flag
func (f *IntSliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *IntSliceFlag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
MultiError is an error that wraps multiple errors.
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 PathFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
TakesFile bool
Value string
DefaultText string
Destination *string
HasBeenSet bool
}Apply populates the flag given the flag set and environment
GetUsage returns the usage string for the flag
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
IsRequired returns whether or not the flag is required
IsSet returns whether or not the flag has been set through env or file
Names returns the names of the flag
String returns a readable representation of this value (for usage defaults)
TakesValue returns true of the flag takes a value, otherwise false
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 StringFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
TakesFile bool
Value string
DefaultText string
Destination *string
HasBeenSet bool
}StringFlag is a flag with type string
func (f *StringFlag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f *StringFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *StringFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *StringFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *StringFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *StringFlag) Names() []string
Names returns the names of the flag
func (f *StringFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *StringFlag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
type StringSlice struct {
// contains filtered or unexported fields
}StringSlice wraps a []string to satisfy flag.Value
func NewStringSlice(defaults ...string) *StringSlice
NewStringSlice creates a *StringSlice with default values
func (s *StringSlice) Get() interface{}
Get returns the slice of strings set by this flag
func (s *StringSlice) Serialize() string
Serialize allows StringSlice to fulfill Serializer
func (s *StringSlice) Set(value string) error
Set appends the string value to the list of values
func (s *StringSlice) String() string
String returns a readable representation of this value (for usage defaults)
func (s *StringSlice) Value() []string
Value returns the slice of strings set by this flag
type StringSliceFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
TakesFile bool
Value *StringSlice
DefaultText string
HasBeenSet bool
}StringSliceFlag is a flag with type *StringSlice
func (f *StringSliceFlag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f *StringSliceFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *StringSliceFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *StringSliceFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *StringSliceFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *StringSliceFlag) Names() []string
Names returns the names of the flag
func (f *StringSliceFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *StringSliceFlag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
type Timestamp struct {
// contains filtered or unexported fields
}Timestamp wrap to satisfy golang's flag interface.
Timestamp constructor
Get returns the flag structure
Parses the string value to timestamp
Set the timestamp string layout for future parsing
Set the timestamp value directly
String returns a readable representation of this value (for usage defaults)
Value returns the timestamp value stored in the flag
type TimestampFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Layout string
Value *Timestamp
DefaultText string
HasBeenSet bool
}TimestampFlag is a flag with type time
func (f *TimestampFlag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f *TimestampFlag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *TimestampFlag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *TimestampFlag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *TimestampFlag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *TimestampFlag) Names() []string
Names returns the names of the flag
func (f *TimestampFlag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *TimestampFlag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
type Uint64Flag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value uint64
DefaultText string
Destination *uint64
HasBeenSet bool
}Uint64Flag is a flag with type uint64
func (f *Uint64Flag) Apply(set *flag.FlagSet) error
Apply populates the flag given the flag set and environment
func (f *Uint64Flag) GetUsage() string
GetUsage returns the usage string for the flag
func (f *Uint64Flag) GetValue() string
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
func (f *Uint64Flag) IsRequired() bool
IsRequired returns whether or not the flag is required
func (f *Uint64Flag) IsSet() bool
IsSet returns whether or not the flag has been set through env or file
func (f *Uint64Flag) Names() []string
Names returns the names of the flag
func (f *Uint64Flag) String() string
String returns a readable representation of this value (for usage defaults)
func (f *Uint64Flag) TakesValue() bool
TakesValue returns true of the flag takes a value, otherwise false
type UintFlag struct {
Name string
Aliases []string
Usage string
EnvVars []string
FilePath string
Required bool
Hidden bool
Value uint
DefaultText string
Destination *uint
HasBeenSet bool
}UintFlag is a flag with type uint
Apply populates the flag given the flag set and environment
GetUsage returns the usage string for the flag
GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.
IsRequired returns whether or not the flag is required
IsSet returns whether or not the flag has been set through env or file
Names returns the names of the flag
String returns a readable representation of this value (for usage defaults)
TakesValue returns true of the flag takes a value, otherwise false
| Path | Synopsis |
|---|---|
| altsrc |
Package cli imports 23 packages (graph) and is imported by 3877 packages. Updated 2020-02-27. Refresh now. Tools for package owners.