README

cli

Build Status Windows Build Status

GoDoc codebeat Go Report Card codecov

cli is a simple, fast, and fun package for building command line apps in Go. The goal is to enable developers to write fast and distributable command line applications in an expressive way.

Usage Documentation

Usage documentation exists for each major version

Installation

Make sure you have a working Go environment. Go version 1.10+ is supported. See the install instructions for Go.

GOPATH

Make sure your PATH includes the $GOPATH/bin directory so your commands can be easily used:

export PATH=$PATH:$GOPATH/bin
Supported platforms

cli is tested against multiple versions of Go on Linux, and against the latest released version of Go on OS X and Windows. For full details, see ./.travis.yml and ./appveyor.yml.

Using v1 releases
$ go get github.com/urfave/cli
...
import (
  "github.com/urfave/cli"
)
...
Using v2 releases

Warning: v2 is in a pre-release state.

$ go get github.com/urfave/cli.v2
...
import (
  "github.com/urfave/cli.v2" // imports as package "cli"
)
...
Expand ▾ Collapse ▴

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.NewApp().Run(os.Args)
    }
    

    Of course this application does not do much, so let's make this an actual application:

    func main() {
      app := cli.NewApp()
      app.Name = "greet"
      app.Usage = "say a greeting"
      app.Action = func(c *cli.Context) error {
        println("Greetings")
        return nil
      }
    
      app.Run(os.Args)
    }
    

    Index

    Examples

    Constants

    This section is empty.

    Variables

    View Source
    var AppHelpTemplate = `` /* 1055-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.

      View Source
      var CommandHelpTemplate = `` /* 404-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.

        View Source
        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.

          View Source
          var FishCompletionTemplate = `` /* 358-byte string literal not displayed */
          
          View Source
          var HelpPrinter helpPrinter = printHelp

            HelpPrinter 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.

            View Source
            var HelpPrinterCustom helpPrinterCustom = printHelpCustom

              HelpPrinterCustom 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.

              View Source
              var MarkdownDocTemplate = `% {{ .App.Name }}(8) {{ .App.Description }}
              
              % {{ .App.Author }}
              
              # NAME
              
              {{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }}
              
              # SYNOPSIS
              
              {{ .App.Name }}
              {{ if .SynopsisArgs }}
              ` + "```" + `
              {{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + `
              {{ end }}{{ if .App.UsageText }}
              # DESCRIPTION
              
              {{ .App.UsageText }}
              {{ end }}
              **Usage**:
              
              ` + "```" + `
              {{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
              ` + "```" + `
              {{ if .GlobalArgs }}
              # GLOBAL OPTIONS
              {{ range $v := .GlobalArgs }}
              {{ $v }}{{ end }}
              {{ end }}{{ if .Commands }}
              # COMMANDS
              {{ range $v := .Commands }}
              {{ $v }}{{ end }}{{ end }}`
              View Source
              var OsExiter = os.Exit

                OsExiter is the function used when the app exits. If not set defaults to os.Exit.

                View Source
                var SubcommandHelpTemplate = `` /* 591-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.

                  View Source
                  var VersionPrinter = printVersion

                    VersionPrinter prints the version for the App

                    Functions

                    func DefaultAppComplete

                    func DefaultAppComplete(c *Context)

                      DefaultAppComplete prints the list of subcommands as the default app completion method

                      func DefaultCompleteWithFlags

                      func DefaultCompleteWithFlags(cmd *Command) func(c *Context)

                      func HandleAction

                      func HandleAction(action interface{}, context *Context) (err error)

                        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!

                        func HandleExitCoder

                        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 and calls OsExiter with the last exit code.

                          func ShowAppHelp

                          func ShowAppHelp(c *Context) error

                            ShowAppHelp is an action that displays the help.

                            func ShowAppHelpAndExit

                            func ShowAppHelpAndExit(c *Context, exitCode int)

                              ShowAppHelpAndExit - Prints the list of subcommands for the app and exits with exit code.

                              func ShowCommandCompletions

                              func ShowCommandCompletions(ctx *Context, command string)

                                ShowCommandCompletions prints the custom completions for a given command

                                func ShowCommandHelp

                                func ShowCommandHelp(ctx *Context, command string) error

                                  ShowCommandHelp prints help for the given command

                                  func ShowCommandHelpAndExit

                                  func ShowCommandHelpAndExit(c *Context, command string, code int)

                                    ShowCommandHelpAndExit - exits with code after showing help

                                    func ShowCompletions

                                    func ShowCompletions(c *Context)

                                      ShowCompletions prints the lists of commands within a given context

                                      func ShowSubcommandHelp

                                      func ShowSubcommandHelp(c *Context) error

                                        ShowSubcommandHelp prints help for the given subcommand

                                        func ShowVersion

                                        func ShowVersion(c *Context)

                                          ShowVersion prints the version number of the App

                                          Types

                                          type ActionFunc

                                          type ActionFunc func(*Context) error

                                            ActionFunc is the action to execute when no subcommands are specified

                                            type AfterFunc

                                            type AfterFunc func(*Context) error

                                              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 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 bash-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
                                              	// Expects a `cli.ActionFunc` but will accept the *deprecated* signature of `func(*cli.Context) {}`
                                              	// *Note*: support for the deprecated `Action` signature will be removed in a future version
                                              	Action interface{}
                                              
                                              	// 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
                                              	// Name of Author (Note: Use App.Authors, this is deprecated)
                                              	Author string
                                              	// Email of Author (Note: Use App.Authors, this is deprecated)
                                              	Email 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 arguements 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

                                                func NewApp

                                                func NewApp() *App

                                                  NewApp creates a new cli Application with some reasonable defaults for Name, Usage, Version and Action.

                                                  func (*App) Categories

                                                  func (a *App) Categories() CommandCategories

                                                    Categories returns a slice containing all the categories with the commands they contain

                                                    func (*App) Command

                                                    func (a *App) Command(name string) *Command

                                                      Command returns the named command on App. Returns nil if the command does not exist

                                                      func (*App) Run

                                                      func (a *App) Run(arguments []string) (err error)

                                                        Run is the entry point to the cli app. Parses the arguments slice and routes to the proper flag/args combination

                                                        Example
                                                        Output:
                                                        
                                                        Hello Jeremy
                                                        
                                                        Example (AppHelp)
                                                        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
                                                           --version, -v  print the version
                                                        
                                                        Example (BashComplete)
                                                        Output:
                                                        
                                                        describeit
                                                        d
                                                        next
                                                        help
                                                        h
                                                        
                                                        Example (BashComplete_withLongFlag)
                                                        Output:
                                                        
                                                        --some-flag
                                                        --similar-flag
                                                        
                                                        Example (BashComplete_withMultipleLongFlag)
                                                        Output:
                                                        
                                                        --string
                                                        --string-flag-2
                                                        
                                                        Example (BashComplete_withShortFlag)
                                                        Output:
                                                        
                                                        --other
                                                        -o
                                                        --xyz
                                                        -x
                                                        --help
                                                        -h
                                                        
                                                        Example (CommandHelp)
                                                        Output:
                                                        
                                                        NAME:
                                                           greet describeit - use it to see a description
                                                        
                                                        USAGE:
                                                           greet describeit [arguments...]
                                                        
                                                        DESCRIPTION:
                                                           This is how we describe describeit the function
                                                        
                                                        Example (NoAction)
                                                        Output:
                                                        
                                                        NAME:
                                                           greet
                                                        
                                                        USAGE:
                                                            [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
                                                        
                                                        Example (Subcommand)
                                                        Output:
                                                        
                                                        Hello, Jeremy
                                                        
                                                        Example (SubcommandNoAction)
                                                        Output:
                                                        
                                                        NAME:
                                                            describeit - use it to see a description
                                                        
                                                        USAGE:
                                                            describeit [arguments...]
                                                        
                                                        DESCRIPTION:
                                                           This is how we describe describeit the function
                                                        
                                                        Example (ZshComplete)
                                                        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
                                                        

                                                        func (*App) RunAndExitOnError

                                                        func (a *App) RunAndExitOnError()

                                                          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

                                                          func (*App) RunAsSubcommand

                                                          func (a *App) RunAsSubcommand(ctx *Context) (err error)

                                                            RunAsSubcommand invokes the subcommand given the context, parses ctx.Args() to generate command-specific flags

                                                            func (*App) Setup

                                                            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) ToFishCompletion

                                                              func (a *App) ToFishCompletion() (string, error)

                                                                ToFishCompletion creates a fish completion string for the `*App` The function errors if either parsing or writing of the string fails.

                                                                func (*App) ToMan

                                                                func (a *App) ToMan() (string, error)

                                                                  ToMan creates a man page string for the `*App` The function errors if either parsing or writing of the string fails.

                                                                  func (*App) ToMarkdown

                                                                  func (a *App) ToMarkdown() (string, error)

                                                                    ToMarkdown creates a markdown string for the `*App` The function errors if either parsing or writing of the string fails.

                                                                    func (*App) VisibleCategories

                                                                    func (a *App) VisibleCategories() []*CommandCategory

                                                                      VisibleCategories returns a slice of categories and commands that are Hidden=false

                                                                      func (*App) VisibleCommands

                                                                      func (a *App) VisibleCommands() []Command

                                                                        VisibleCommands returns a slice of the Commands with Hidden=false

                                                                        func (*App) VisibleFlags

                                                                        func (a *App) VisibleFlags() []Flag

                                                                          VisibleFlags returns a slice of the Flags with Hidden=false

                                                                          type Args

                                                                          type Args []string

                                                                            Args contains apps console arguments

                                                                            func (Args) First

                                                                            func (a Args) First() string

                                                                              First returns the first argument, or else a blank string

                                                                              func (Args) Get

                                                                              func (a Args) Get(n int) string

                                                                                Get returns the nth argument, or else a blank string

                                                                                func (Args) Present

                                                                                func (a Args) Present() bool

                                                                                  Present checks if there are any arguments present

                                                                                  func (Args) Swap

                                                                                  func (a Args) Swap(from, to int) error

                                                                                    Swap swaps arguments at the given indexes

                                                                                    func (Args) Tail

                                                                                    func (a Args) Tail() []string

                                                                                      Tail returns the rest of the arguments (not the first one) or else an empty string slice

                                                                                      type Author

                                                                                      type Author struct {
                                                                                      	Name  string // The Authors name
                                                                                      	Email string // The Authors email
                                                                                      }

                                                                                        Author represents someone who has contributed to a cli project.

                                                                                        func (Author) String

                                                                                        func (a Author) String() string

                                                                                          String makes Author comply to the Stringer interface, to allow an easy print in the templating process

                                                                                          type BashCompleteFunc

                                                                                          type BashCompleteFunc func(*Context)

                                                                                            BashCompleteFunc is an action to execute when the bash-completion flag is set

                                                                                            type BeforeFunc

                                                                                            type BeforeFunc func(*Context) error

                                                                                              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
                                                                                              	Usage       string
                                                                                              	EnvVar      string
                                                                                              	FilePath    string
                                                                                              	Required    bool
                                                                                              	Hidden      bool
                                                                                              	Destination *bool
                                                                                              }

                                                                                                BoolFlag is a flag with type bool

                                                                                                func (BoolFlag) Apply

                                                                                                func (f BoolFlag) Apply(set *flag.FlagSet)

                                                                                                  Apply populates the flag given the flag set and environment Ignores errors

                                                                                                  func (BoolFlag) ApplyWithError

                                                                                                  func (f BoolFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                    ApplyWithError populates the flag given the flag set and environment

                                                                                                    func (BoolFlag) GetName

                                                                                                    func (f BoolFlag) GetName() string

                                                                                                      GetName returns the name of the flag

                                                                                                      func (BoolFlag) GetUsage

                                                                                                      func (f BoolFlag) GetUsage() string

                                                                                                        GetUsage returns the usage string for the flag

                                                                                                        func (BoolFlag) GetValue

                                                                                                        func (f BoolFlag) GetValue() string

                                                                                                          GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.

                                                                                                          func (BoolFlag) IsRequired

                                                                                                          func (f BoolFlag) IsRequired() bool

                                                                                                            IsRequired returns whether or not the flag is required

                                                                                                            func (BoolFlag) String

                                                                                                            func (f BoolFlag) String() string

                                                                                                              String returns a readable representation of this value (for usage defaults)

                                                                                                              func (BoolFlag) TakesValue

                                                                                                              func (f BoolFlag) TakesValue() bool

                                                                                                                TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                type BoolTFlag

                                                                                                                type BoolTFlag struct {
                                                                                                                	Name        string
                                                                                                                	Usage       string
                                                                                                                	EnvVar      string
                                                                                                                	FilePath    string
                                                                                                                	Required    bool
                                                                                                                	Hidden      bool
                                                                                                                	Destination *bool
                                                                                                                }

                                                                                                                  BoolTFlag is a flag with type bool that is true by default

                                                                                                                  func (BoolTFlag) Apply

                                                                                                                  func (f BoolTFlag) Apply(set *flag.FlagSet)

                                                                                                                    Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                    func (BoolTFlag) ApplyWithError

                                                                                                                    func (f BoolTFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                      ApplyWithError populates the flag given the flag set and environment

                                                                                                                      func (BoolTFlag) GetName

                                                                                                                      func (f BoolTFlag) GetName() string

                                                                                                                        GetName returns the name of the flag

                                                                                                                        func (BoolTFlag) GetUsage

                                                                                                                        func (f BoolTFlag) GetUsage() string

                                                                                                                          GetUsage returns the usage string for the flag

                                                                                                                          func (BoolTFlag) GetValue

                                                                                                                          func (f BoolTFlag) GetValue() string

                                                                                                                            GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.

                                                                                                                            func (BoolTFlag) IsRequired

                                                                                                                            func (f BoolTFlag) IsRequired() bool

                                                                                                                              IsRequired returns whether or not the flag is required

                                                                                                                              func (BoolTFlag) String

                                                                                                                              func (f BoolTFlag) String() string

                                                                                                                                String returns a readable representation of this value (for usage defaults)

                                                                                                                                func (BoolTFlag) TakesValue

                                                                                                                                func (f BoolTFlag) TakesValue() bool

                                                                                                                                  TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                  type Command

                                                                                                                                  type Command struct {
                                                                                                                                  	// The name of the command
                                                                                                                                  	Name string
                                                                                                                                  	// short name of the command. Typically one character (deprecated, use `Aliases`)
                                                                                                                                  	ShortName 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 interface{}
                                                                                                                                  
                                                                                                                                  	// Execute this function if a usage error occurs.
                                                                                                                                  	OnUsageError OnUsageErrorFunc
                                                                                                                                  	// List of child commands
                                                                                                                                  	Subcommands Commands
                                                                                                                                  	// List of flags to parse
                                                                                                                                  	Flags []Flag
                                                                                                                                  	// Treat all flags as normal arguments if true
                                                                                                                                  	SkipFlagParsing bool
                                                                                                                                  	// Skip argument reordering which attempts to move flags before arguments,
                                                                                                                                  	// but only works if all flags appear after all arguments. This behavior was
                                                                                                                                  	// removed n version 2 since it only works under specific conditions so we
                                                                                                                                  	// backport here by exposing it as an option for compatibility.
                                                                                                                                  	SkipArgReorder 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.

                                                                                                                                    func (Command) FullName

                                                                                                                                    func (c Command) FullName() string

                                                                                                                                      FullName returns the full name of the command. For subcommands this ensures that parent commands are part of the command path

                                                                                                                                      func (Command) HasName

                                                                                                                                      func (c Command) HasName(name string) bool

                                                                                                                                        HasName returns true if Command.Name or Command.ShortName matches given name

                                                                                                                                        func (Command) Names

                                                                                                                                        func (c Command) Names() []string

                                                                                                                                          Names returns the names including short names and aliases.

                                                                                                                                          func (Command) Run

                                                                                                                                          func (c Command) Run(ctx *Context) (err error)

                                                                                                                                            Run invokes the command given the context, parses ctx.Args() to generate command-specific flags

                                                                                                                                            func (Command) VisibleFlags

                                                                                                                                            func (c Command) VisibleFlags() []Flag

                                                                                                                                              VisibleFlags returns a slice of the Flags with Hidden=false

                                                                                                                                              type CommandCategories

                                                                                                                                              type CommandCategories []*CommandCategory

                                                                                                                                                CommandCategories is a slice of *CommandCategory.

                                                                                                                                                func (CommandCategories) AddCommand

                                                                                                                                                func (c CommandCategories) AddCommand(category string, command Command) CommandCategories

                                                                                                                                                  AddCommand adds a command to a category.

                                                                                                                                                  func (CommandCategories) Len

                                                                                                                                                  func (c CommandCategories) Len() int

                                                                                                                                                  func (CommandCategories) Less

                                                                                                                                                  func (c CommandCategories) Less(i, j int) bool

                                                                                                                                                  func (CommandCategories) Swap

                                                                                                                                                  func (c CommandCategories) Swap(i, j int)

                                                                                                                                                  type CommandCategory

                                                                                                                                                  type CommandCategory struct {
                                                                                                                                                  	Name     string
                                                                                                                                                  	Commands Commands
                                                                                                                                                  }

                                                                                                                                                    CommandCategory is a category containing commands.

                                                                                                                                                    func (*CommandCategory) VisibleCommands

                                                                                                                                                    func (c *CommandCategory) VisibleCommands() []Command

                                                                                                                                                      VisibleCommands returns a slice of the Commands with Hidden=false

                                                                                                                                                      type CommandNotFoundFunc

                                                                                                                                                      type CommandNotFoundFunc func(*Context, string)

                                                                                                                                                        CommandNotFoundFunc is executed if the proper command cannot be found

                                                                                                                                                        type Commands

                                                                                                                                                        type Commands []Command

                                                                                                                                                          Commands is a slice of Command

                                                                                                                                                          type CommandsByName

                                                                                                                                                          type CommandsByName []Command

                                                                                                                                                          func (CommandsByName) Len

                                                                                                                                                          func (c CommandsByName) Len() int

                                                                                                                                                          func (CommandsByName) Less

                                                                                                                                                          func (c CommandsByName) Less(i, j int) bool

                                                                                                                                                          func (CommandsByName) Swap

                                                                                                                                                          func (c CommandsByName) Swap(i, j int)

                                                                                                                                                          type Context

                                                                                                                                                          type Context struct {
                                                                                                                                                          	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.

                                                                                                                                                            func NewContext

                                                                                                                                                            func NewContext(app *App, set *flag.FlagSet, parentCtx *Context) *Context

                                                                                                                                                              NewContext creates a new context. For use in when invoking an App or Command action.

                                                                                                                                                              func (*Context) Args

                                                                                                                                                              func (c *Context) Args() Args

                                                                                                                                                                Args returns the command line arguments associated with the context.

                                                                                                                                                                func (*Context) Bool

                                                                                                                                                                func (c *Context) Bool(name string) bool

                                                                                                                                                                  Bool looks up the value of a local BoolFlag, returns false if not found

                                                                                                                                                                  func (*Context) BoolT

                                                                                                                                                                  func (c *Context) BoolT(name string) bool

                                                                                                                                                                    BoolT looks up the value of a local BoolTFlag, returns false if not found

                                                                                                                                                                    func (*Context) Duration

                                                                                                                                                                    func (c *Context) Duration(name string) time.Duration

                                                                                                                                                                      Duration looks up the value of a local DurationFlag, returns 0 if not found

                                                                                                                                                                      func (*Context) FlagNames

                                                                                                                                                                      func (c *Context) FlagNames() (names []string)

                                                                                                                                                                        FlagNames returns a slice of flag names used in this context.

                                                                                                                                                                        func (*Context) Float64

                                                                                                                                                                        func (c *Context) Float64(name string) float64

                                                                                                                                                                          Float64 looks up the value of a local Float64Flag, returns 0 if not found

                                                                                                                                                                          func (*Context) Generic

                                                                                                                                                                          func (c *Context) Generic(name string) interface{}

                                                                                                                                                                            Generic looks up the value of a local GenericFlag, returns nil if not found

                                                                                                                                                                            func (*Context) GlobalBool

                                                                                                                                                                            func (c *Context) GlobalBool(name string) bool

                                                                                                                                                                              GlobalBool looks up the value of a global BoolFlag, returns false if not found

                                                                                                                                                                              func (*Context) GlobalBoolT

                                                                                                                                                                              func (c *Context) GlobalBoolT(name string) bool

                                                                                                                                                                                GlobalBoolT looks up the value of a global BoolTFlag, returns false if not found

                                                                                                                                                                                func (*Context) GlobalDuration

                                                                                                                                                                                func (c *Context) GlobalDuration(name string) time.Duration

                                                                                                                                                                                  GlobalDuration looks up the value of a global DurationFlag, returns 0 if not found

                                                                                                                                                                                  func (*Context) GlobalFlagNames

                                                                                                                                                                                  func (c *Context) GlobalFlagNames() (names []string)

                                                                                                                                                                                    GlobalFlagNames returns a slice of global flag names used by the app.

                                                                                                                                                                                    func (*Context) GlobalFloat64

                                                                                                                                                                                    func (c *Context) GlobalFloat64(name string) float64

                                                                                                                                                                                      GlobalFloat64 looks up the value of a global Float64Flag, returns 0 if not found

                                                                                                                                                                                      func (*Context) GlobalGeneric

                                                                                                                                                                                      func (c *Context) GlobalGeneric(name string) interface{}

                                                                                                                                                                                        GlobalGeneric looks up the value of a global GenericFlag, returns nil if not found

                                                                                                                                                                                        func (*Context) GlobalInt

                                                                                                                                                                                        func (c *Context) GlobalInt(name string) int

                                                                                                                                                                                          GlobalInt looks up the value of a global IntFlag, returns 0 if not found

                                                                                                                                                                                          func (*Context) GlobalInt64

                                                                                                                                                                                          func (c *Context) GlobalInt64(name string) int64

                                                                                                                                                                                            GlobalInt64 looks up the value of a global Int64Flag, returns 0 if not found

                                                                                                                                                                                            func (*Context) GlobalInt64Slice

                                                                                                                                                                                            func (c *Context) GlobalInt64Slice(name string) []int64

                                                                                                                                                                                              GlobalInt64Slice looks up the value of a global Int64SliceFlag, returns nil if not found

                                                                                                                                                                                              func (*Context) GlobalIntSlice

                                                                                                                                                                                              func (c *Context) GlobalIntSlice(name string) []int

                                                                                                                                                                                                GlobalIntSlice looks up the value of a global IntSliceFlag, returns nil if not found

                                                                                                                                                                                                func (*Context) GlobalIsSet

                                                                                                                                                                                                func (c *Context) GlobalIsSet(name string) bool

                                                                                                                                                                                                  GlobalIsSet determines if the global flag was actually set

                                                                                                                                                                                                  func (*Context) GlobalSet

                                                                                                                                                                                                  func (c *Context) GlobalSet(name, value string) error

                                                                                                                                                                                                    GlobalSet sets a context flag to a value on the global flagset

                                                                                                                                                                                                    func (*Context) GlobalString

                                                                                                                                                                                                    func (c *Context) GlobalString(name string) string

                                                                                                                                                                                                      GlobalString looks up the value of a global StringFlag, returns "" if not found

                                                                                                                                                                                                      func (*Context) GlobalStringSlice

                                                                                                                                                                                                      func (c *Context) GlobalStringSlice(name string) []string

                                                                                                                                                                                                        GlobalStringSlice looks up the value of a global StringSliceFlag, returns nil if not found

                                                                                                                                                                                                        func (*Context) GlobalUint

                                                                                                                                                                                                        func (c *Context) GlobalUint(name string) uint

                                                                                                                                                                                                          GlobalUint looks up the value of a global UintFlag, returns 0 if not found

                                                                                                                                                                                                          func (*Context) GlobalUint64

                                                                                                                                                                                                          func (c *Context) GlobalUint64(name string) uint64

                                                                                                                                                                                                            GlobalUint64 looks up the value of a global Uint64Flag, returns 0 if not found

                                                                                                                                                                                                            func (*Context) Int

                                                                                                                                                                                                            func (c *Context) Int(name string) int

                                                                                                                                                                                                              Int looks up the value of a local IntFlag, returns 0 if not found

                                                                                                                                                                                                              func (*Context) Int64

                                                                                                                                                                                                              func (c *Context) Int64(name string) int64

                                                                                                                                                                                                                Int64 looks up the value of a local Int64Flag, returns 0 if not found

                                                                                                                                                                                                                func (*Context) Int64Slice

                                                                                                                                                                                                                func (c *Context) Int64Slice(name string) []int64

                                                                                                                                                                                                                  Int64Slice looks up the value of a local Int64SliceFlag, returns nil if not found

                                                                                                                                                                                                                  func (*Context) IntSlice

                                                                                                                                                                                                                  func (c *Context) IntSlice(name string) []int

                                                                                                                                                                                                                    IntSlice looks up the value of a local IntSliceFlag, returns nil if not found

                                                                                                                                                                                                                    func (*Context) IsSet

                                                                                                                                                                                                                    func (c *Context) IsSet(name string) bool

                                                                                                                                                                                                                      IsSet determines if the flag was actually set

                                                                                                                                                                                                                      func (*Context) NArg

                                                                                                                                                                                                                      func (c *Context) NArg() int

                                                                                                                                                                                                                        NArg returns the number of the command line arguments.

                                                                                                                                                                                                                        func (*Context) NumFlags

                                                                                                                                                                                                                        func (c *Context) NumFlags() int

                                                                                                                                                                                                                          NumFlags returns the number of flags set

                                                                                                                                                                                                                          func (*Context) Parent

                                                                                                                                                                                                                          func (c *Context) Parent() *Context

                                                                                                                                                                                                                            Parent returns the parent context, if any

                                                                                                                                                                                                                            func (*Context) Set

                                                                                                                                                                                                                            func (c *Context) Set(name, value string) error

                                                                                                                                                                                                                              Set sets a context flag to a value.

                                                                                                                                                                                                                              func (*Context) String

                                                                                                                                                                                                                              func (c *Context) String(name string) string

                                                                                                                                                                                                                                String looks up the value of a local StringFlag, returns "" if not found

                                                                                                                                                                                                                                func (*Context) StringSlice

                                                                                                                                                                                                                                func (c *Context) StringSlice(name string) []string

                                                                                                                                                                                                                                  StringSlice looks up the value of a local StringSliceFlag, returns nil if not found

                                                                                                                                                                                                                                  func (*Context) Uint

                                                                                                                                                                                                                                  func (c *Context) Uint(name string) uint

                                                                                                                                                                                                                                    Uint looks up the value of a local UintFlag, returns 0 if not found

                                                                                                                                                                                                                                    func (*Context) Uint64

                                                                                                                                                                                                                                    func (c *Context) Uint64(name string) uint64

                                                                                                                                                                                                                                      Uint64 looks up the value of a local Uint64Flag, returns 0 if not found

                                                                                                                                                                                                                                      type DocGenerationFlag

                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                        type DurationFlag struct {
                                                                                                                                                                                                                                        	Name        string
                                                                                                                                                                                                                                        	Usage       string
                                                                                                                                                                                                                                        	EnvVar      string
                                                                                                                                                                                                                                        	FilePath    string
                                                                                                                                                                                                                                        	Required    bool
                                                                                                                                                                                                                                        	Hidden      bool
                                                                                                                                                                                                                                        	Value       time.Duration
                                                                                                                                                                                                                                        	Destination *time.Duration
                                                                                                                                                                                                                                        }

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

                                                                                                                                                                                                                                          func (DurationFlag) Apply

                                                                                                                                                                                                                                          func (f DurationFlag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                            Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                            func (DurationFlag) ApplyWithError

                                                                                                                                                                                                                                            func (f DurationFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                              ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                              func (DurationFlag) GetName

                                                                                                                                                                                                                                              func (f DurationFlag) GetName() string

                                                                                                                                                                                                                                                GetName returns the name of the flag

                                                                                                                                                                                                                                                func (DurationFlag) GetUsage

                                                                                                                                                                                                                                                func (f DurationFlag) GetUsage() string

                                                                                                                                                                                                                                                  GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                  func (DurationFlag) GetValue

                                                                                                                                                                                                                                                  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 (DurationFlag) IsRequired

                                                                                                                                                                                                                                                    func (f DurationFlag) IsRequired() bool

                                                                                                                                                                                                                                                      IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                      func (DurationFlag) String

                                                                                                                                                                                                                                                      func (f DurationFlag) String() string

                                                                                                                                                                                                                                                        String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                        func (DurationFlag) TakesValue

                                                                                                                                                                                                                                                        func (f DurationFlag) TakesValue() bool

                                                                                                                                                                                                                                                          TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                          type ErrorFormatter

                                                                                                                                                                                                                                                          type ErrorFormatter interface {
                                                                                                                                                                                                                                                          	Format(s fmt.State, verb rune)
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          type ExitCoder

                                                                                                                                                                                                                                                          type ExitCoder interface {
                                                                                                                                                                                                                                                          	error
                                                                                                                                                                                                                                                          	ExitCode() int
                                                                                                                                                                                                                                                          }

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

                                                                                                                                                                                                                                                            type ExitErrHandlerFunc

                                                                                                                                                                                                                                                            type ExitErrHandlerFunc func(context *Context, err error)

                                                                                                                                                                                                                                                              ExitErrHandlerFunc is executed if provided in order to handle ExitError values returned by Actions and Before/After functions.

                                                                                                                                                                                                                                                              type ExitError

                                                                                                                                                                                                                                                              type ExitError struct {
                                                                                                                                                                                                                                                              	// contains filtered or unexported fields
                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                ExitError fulfills both the builtin `error` interface and `ExitCoder`

                                                                                                                                                                                                                                                                func NewExitError

                                                                                                                                                                                                                                                                func NewExitError(message interface{}, exitCode int) *ExitError

                                                                                                                                                                                                                                                                  NewExitError makes a new *ExitError

                                                                                                                                                                                                                                                                  func (*ExitError) Error

                                                                                                                                                                                                                                                                  func (ee *ExitError) Error() string

                                                                                                                                                                                                                                                                    Error returns the string message, fulfilling the interface required by `error`

                                                                                                                                                                                                                                                                    func (*ExitError) ExitCode

                                                                                                                                                                                                                                                                    func (ee *ExitError) ExitCode() int

                                                                                                                                                                                                                                                                      ExitCode returns the exit code, fulfilling the interface required by `ExitCoder`

                                                                                                                                                                                                                                                                      type Flag

                                                                                                                                                                                                                                                                      type Flag interface {
                                                                                                                                                                                                                                                                      	fmt.Stringer
                                                                                                                                                                                                                                                                      	// Apply Flag settings to the given flag set
                                                                                                                                                                                                                                                                      	Apply(*flag.FlagSet)
                                                                                                                                                                                                                                                                      	GetName() 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.

                                                                                                                                                                                                                                                                        var BashCompletionFlag Flag = BoolFlag{
                                                                                                                                                                                                                                                                        	Name:   "generate-bash-completion",
                                                                                                                                                                                                                                                                        	Hidden: true,
                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                          BashCompletionFlag enables bash-completion for all commands and subcommands

                                                                                                                                                                                                                                                                          var HelpFlag Flag = BoolFlag{
                                                                                                                                                                                                                                                                          	Name:  "help, h",
                                                                                                                                                                                                                                                                          	Usage: "show help",
                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                            HelpFlag prints the help for all commands and subcommands Set to the zero value (BoolFlag{}) to disable flag -- keeps subcommand unless HideHelp is set to true)

                                                                                                                                                                                                                                                                            var VersionFlag Flag = BoolFlag{
                                                                                                                                                                                                                                                                            	Name:  "version, v",
                                                                                                                                                                                                                                                                            	Usage: "print the version",
                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                              VersionFlag prints the version for the application

                                                                                                                                                                                                                                                                              type FlagEnvHintFunc

                                                                                                                                                                                                                                                                              type FlagEnvHintFunc func(envVar, str string) string

                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                  type FlagFileHintFunc

                                                                                                                                                                                                                                                                                  type FlagFileHintFunc func(filePath, str string) string

                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                      type FlagNamePrefixFunc

                                                                                                                                                                                                                                                                                      type FlagNamePrefixFunc func(fullName, placeholder string) string

                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                          type FlagStringFunc

                                                                                                                                                                                                                                                                                          type FlagStringFunc func(Flag) string

                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                              type FlagsByName []Flag

                                                                                                                                                                                                                                                                                                FlagsByName is a slice of Flag.

                                                                                                                                                                                                                                                                                                func (FlagsByName) Len

                                                                                                                                                                                                                                                                                                func (f FlagsByName) Len() int

                                                                                                                                                                                                                                                                                                func (FlagsByName) Less

                                                                                                                                                                                                                                                                                                func (f FlagsByName) Less(i, j int) bool

                                                                                                                                                                                                                                                                                                func (FlagsByName) Swap

                                                                                                                                                                                                                                                                                                func (f FlagsByName) Swap(i, j int)

                                                                                                                                                                                                                                                                                                type Float64Flag

                                                                                                                                                                                                                                                                                                type Float64Flag struct {
                                                                                                                                                                                                                                                                                                	Name        string
                                                                                                                                                                                                                                                                                                	Usage       string
                                                                                                                                                                                                                                                                                                	EnvVar      string
                                                                                                                                                                                                                                                                                                	FilePath    string
                                                                                                                                                                                                                                                                                                	Required    bool
                                                                                                                                                                                                                                                                                                	Hidden      bool
                                                                                                                                                                                                                                                                                                	Value       float64
                                                                                                                                                                                                                                                                                                	Destination *float64
                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                  Float64Flag is a flag with type float64

                                                                                                                                                                                                                                                                                                  func (Float64Flag) Apply

                                                                                                                                                                                                                                                                                                  func (f Float64Flag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                    Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                    func (Float64Flag) ApplyWithError

                                                                                                                                                                                                                                                                                                    func (f Float64Flag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                      ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                      func (Float64Flag) GetName

                                                                                                                                                                                                                                                                                                      func (f Float64Flag) GetName() string

                                                                                                                                                                                                                                                                                                        GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                        func (Float64Flag) GetUsage

                                                                                                                                                                                                                                                                                                        func (f Float64Flag) GetUsage() string

                                                                                                                                                                                                                                                                                                          GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                          func (Float64Flag) GetValue

                                                                                                                                                                                                                                                                                                          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 (Float64Flag) IsRequired

                                                                                                                                                                                                                                                                                                            func (f Float64Flag) IsRequired() bool

                                                                                                                                                                                                                                                                                                              IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                              func (Float64Flag) String

                                                                                                                                                                                                                                                                                                              func (f Float64Flag) String() string

                                                                                                                                                                                                                                                                                                                String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                func (Float64Flag) TakesValue

                                                                                                                                                                                                                                                                                                                func (f Float64Flag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                  TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                  type Generic

                                                                                                                                                                                                                                                                                                                  type Generic interface {
                                                                                                                                                                                                                                                                                                                  	Set(value string) error
                                                                                                                                                                                                                                                                                                                  	String() string
                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                    Generic is a generic parseable type identified by a specific flag

                                                                                                                                                                                                                                                                                                                    type GenericFlag

                                                                                                                                                                                                                                                                                                                    type GenericFlag struct {
                                                                                                                                                                                                                                                                                                                    	Name      string
                                                                                                                                                                                                                                                                                                                    	Usage     string
                                                                                                                                                                                                                                                                                                                    	EnvVar    string
                                                                                                                                                                                                                                                                                                                    	FilePath  string
                                                                                                                                                                                                                                                                                                                    	Required  bool
                                                                                                                                                                                                                                                                                                                    	Hidden    bool
                                                                                                                                                                                                                                                                                                                    	TakesFile bool
                                                                                                                                                                                                                                                                                                                    	Value     Generic
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                      GenericFlag is a flag with type Generic

                                                                                                                                                                                                                                                                                                                      func (GenericFlag) Apply

                                                                                                                                                                                                                                                                                                                      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 Ignores parsing errors

                                                                                                                                                                                                                                                                                                                        func (GenericFlag) ApplyWithError

                                                                                                                                                                                                                                                                                                                        func (f GenericFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                          ApplyWithError takes the flagset and calls Set on the generic flag with the value provided by the user for parsing by the flag

                                                                                                                                                                                                                                                                                                                          func (GenericFlag) GetName

                                                                                                                                                                                                                                                                                                                          func (f GenericFlag) GetName() string

                                                                                                                                                                                                                                                                                                                            GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                            func (GenericFlag) GetUsage

                                                                                                                                                                                                                                                                                                                            func (f GenericFlag) GetUsage() string

                                                                                                                                                                                                                                                                                                                              GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                              func (GenericFlag) GetValue

                                                                                                                                                                                                                                                                                                                              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 (GenericFlag) IsRequired

                                                                                                                                                                                                                                                                                                                                func (f GenericFlag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                  IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                  func (GenericFlag) String

                                                                                                                                                                                                                                                                                                                                  func (f GenericFlag) String() string

                                                                                                                                                                                                                                                                                                                                    String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                    func (GenericFlag) TakesValue

                                                                                                                                                                                                                                                                                                                                    func (f GenericFlag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                      TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                      type Int64Flag

                                                                                                                                                                                                                                                                                                                                      type Int64Flag struct {
                                                                                                                                                                                                                                                                                                                                      	Name        string
                                                                                                                                                                                                                                                                                                                                      	Usage       string
                                                                                                                                                                                                                                                                                                                                      	EnvVar      string
                                                                                                                                                                                                                                                                                                                                      	FilePath    string
                                                                                                                                                                                                                                                                                                                                      	Required    bool
                                                                                                                                                                                                                                                                                                                                      	Hidden      bool
                                                                                                                                                                                                                                                                                                                                      	Value       int64
                                                                                                                                                                                                                                                                                                                                      	Destination *int64
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                        Int64Flag is a flag with type int64

                                                                                                                                                                                                                                                                                                                                        func (Int64Flag) Apply

                                                                                                                                                                                                                                                                                                                                        func (f Int64Flag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                                                          Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                                                          func (Int64Flag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                          func (f Int64Flag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                            ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                            func (Int64Flag) GetName

                                                                                                                                                                                                                                                                                                                                            func (f Int64Flag) GetName() string

                                                                                                                                                                                                                                                                                                                                              GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                              func (Int64Flag) GetUsage

                                                                                                                                                                                                                                                                                                                                              func (f Int64Flag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                func (Int64Flag) GetValue

                                                                                                                                                                                                                                                                                                                                                func (f Int64Flag) GetValue() string

                                                                                                                                                                                                                                                                                                                                                  GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.

                                                                                                                                                                                                                                                                                                                                                  func (Int64Flag) IsRequired

                                                                                                                                                                                                                                                                                                                                                  func (f Int64Flag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                    IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                    func (Int64Flag) String

                                                                                                                                                                                                                                                                                                                                                    func (f Int64Flag) String() string

                                                                                                                                                                                                                                                                                                                                                      String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                      func (Int64Flag) TakesValue

                                                                                                                                                                                                                                                                                                                                                      func (f Int64Flag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                        TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                        type Int64Slice

                                                                                                                                                                                                                                                                                                                                                        type Int64Slice []int64

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

                                                                                                                                                                                                                                                                                                                                                          func (*Int64Slice) Get

                                                                                                                                                                                                                                                                                                                                                          func (f *Int64Slice) Get() interface{}

                                                                                                                                                                                                                                                                                                                                                            Get returns the slice of ints set by this flag

                                                                                                                                                                                                                                                                                                                                                            func (*Int64Slice) Set

                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                              func (f *Int64Slice) String() string

                                                                                                                                                                                                                                                                                                                                                                String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                func (*Int64Slice) Value

                                                                                                                                                                                                                                                                                                                                                                func (f *Int64Slice) Value() []int64

                                                                                                                                                                                                                                                                                                                                                                  Value returns the slice of ints set by this flag

                                                                                                                                                                                                                                                                                                                                                                  type Int64SliceFlag

                                                                                                                                                                                                                                                                                                                                                                  type Int64SliceFlag struct {
                                                                                                                                                                                                                                                                                                                                                                  	Name     string
                                                                                                                                                                                                                                                                                                                                                                  	Usage    string
                                                                                                                                                                                                                                                                                                                                                                  	EnvVar   string
                                                                                                                                                                                                                                                                                                                                                                  	FilePath string
                                                                                                                                                                                                                                                                                                                                                                  	Required bool
                                                                                                                                                                                                                                                                                                                                                                  	Hidden   bool
                                                                                                                                                                                                                                                                                                                                                                  	Value    *Int64Slice
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                    Int64SliceFlag is a flag with type *Int64Slice

                                                                                                                                                                                                                                                                                                                                                                    func (Int64SliceFlag) Apply

                                                                                                                                                                                                                                                                                                                                                                    func (f Int64SliceFlag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                                                                                      Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                                                                                      func (Int64SliceFlag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                                                      func (f Int64SliceFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                                                        ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                                                        func (Int64SliceFlag) GetName

                                                                                                                                                                                                                                                                                                                                                                        func (f Int64SliceFlag) GetName() string

                                                                                                                                                                                                                                                                                                                                                                          GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                                                          func (Int64SliceFlag) GetUsage

                                                                                                                                                                                                                                                                                                                                                                          func (f Int64SliceFlag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                                            GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                                            func (Int64SliceFlag) GetValue

                                                                                                                                                                                                                                                                                                                                                                            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 (Int64SliceFlag) IsRequired

                                                                                                                                                                                                                                                                                                                                                                              func (f Int64SliceFlag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                                                IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                                                func (Int64SliceFlag) String

                                                                                                                                                                                                                                                                                                                                                                                func (f Int64SliceFlag) String() string

                                                                                                                                                                                                                                                                                                                                                                                  String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                  func (Int64SliceFlag) TakesValue

                                                                                                                                                                                                                                                                                                                                                                                  func (f Int64SliceFlag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                                                    TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                    type IntFlag

                                                                                                                                                                                                                                                                                                                                                                                    type IntFlag struct {
                                                                                                                                                                                                                                                                                                                                                                                    	Name        string
                                                                                                                                                                                                                                                                                                                                                                                    	Usage       string
                                                                                                                                                                                                                                                                                                                                                                                    	EnvVar      string
                                                                                                                                                                                                                                                                                                                                                                                    	FilePath    string
                                                                                                                                                                                                                                                                                                                                                                                    	Required    bool
                                                                                                                                                                                                                                                                                                                                                                                    	Hidden      bool
                                                                                                                                                                                                                                                                                                                                                                                    	Value       int
                                                                                                                                                                                                                                                                                                                                                                                    	Destination *int
                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                      IntFlag is a flag with type int

                                                                                                                                                                                                                                                                                                                                                                                      func (IntFlag) Apply

                                                                                                                                                                                                                                                                                                                                                                                      func (f IntFlag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                                                                                                        Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                                                                                                        func (IntFlag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                                                                        func (f IntFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                                                                          ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                                                                          func (IntFlag) GetName

                                                                                                                                                                                                                                                                                                                                                                                          func (f IntFlag) GetName() string

                                                                                                                                                                                                                                                                                                                                                                                            GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                                                                            func (IntFlag) GetUsage

                                                                                                                                                                                                                                                                                                                                                                                            func (f IntFlag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                                                              GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                                                              func (IntFlag) GetValue

                                                                                                                                                                                                                                                                                                                                                                                              func (f IntFlag) GetValue() string

                                                                                                                                                                                                                                                                                                                                                                                                GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.

                                                                                                                                                                                                                                                                                                                                                                                                func (IntFlag) IsRequired

                                                                                                                                                                                                                                                                                                                                                                                                func (f IntFlag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                                                                  IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                                                                  func (IntFlag) String

                                                                                                                                                                                                                                                                                                                                                                                                  func (f IntFlag) String() string

                                                                                                                                                                                                                                                                                                                                                                                                    String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                    func (IntFlag) TakesValue

                                                                                                                                                                                                                                                                                                                                                                                                    func (f IntFlag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                                                                      TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                                      type IntSlice

                                                                                                                                                                                                                                                                                                                                                                                                      type IntSlice []int

                                                                                                                                                                                                                                                                                                                                                                                                        IntSlice is an opaque type for []int to satisfy flag.Value and flag.Getter

                                                                                                                                                                                                                                                                                                                                                                                                        func (*IntSlice) Get

                                                                                                                                                                                                                                                                                                                                                                                                        func (f *IntSlice) Get() interface{}

                                                                                                                                                                                                                                                                                                                                                                                                          Get returns the slice of ints set by this flag

                                                                                                                                                                                                                                                                                                                                                                                                          func (*IntSlice) Set

                                                                                                                                                                                                                                                                                                                                                                                                          func (f *IntSlice) Set(value string) error

                                                                                                                                                                                                                                                                                                                                                                                                            Set parses the value into an integer and appends it to the list of values

                                                                                                                                                                                                                                                                                                                                                                                                            func (*IntSlice) String

                                                                                                                                                                                                                                                                                                                                                                                                            func (f *IntSlice) String() string

                                                                                                                                                                                                                                                                                                                                                                                                              String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                              func (*IntSlice) Value

                                                                                                                                                                                                                                                                                                                                                                                                              func (f *IntSlice) Value() []int

                                                                                                                                                                                                                                                                                                                                                                                                                Value returns the slice of ints set by this flag

                                                                                                                                                                                                                                                                                                                                                                                                                type IntSliceFlag

                                                                                                                                                                                                                                                                                                                                                                                                                type IntSliceFlag struct {
                                                                                                                                                                                                                                                                                                                                                                                                                	Name     string
                                                                                                                                                                                                                                                                                                                                                                                                                	Usage    string
                                                                                                                                                                                                                                                                                                                                                                                                                	EnvVar   string
                                                                                                                                                                                                                                                                                                                                                                                                                	FilePath string
                                                                                                                                                                                                                                                                                                                                                                                                                	Required bool
                                                                                                                                                                                                                                                                                                                                                                                                                	Hidden   bool
                                                                                                                                                                                                                                                                                                                                                                                                                	Value    *IntSlice
                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                  IntSliceFlag is a flag with type *IntSlice

                                                                                                                                                                                                                                                                                                                                                                                                                  func (IntSliceFlag) Apply

                                                                                                                                                                                                                                                                                                                                                                                                                  func (f IntSliceFlag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                                                                                                                                    Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                                                                                                                                    func (IntSliceFlag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                                                                                                    func (f IntSliceFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                                                                                                      ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                                                                                                      func (IntSliceFlag) GetName

                                                                                                                                                                                                                                                                                                                                                                                                                      func (f IntSliceFlag) GetName() string

                                                                                                                                                                                                                                                                                                                                                                                                                        GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                                                                                                        func (IntSliceFlag) GetUsage

                                                                                                                                                                                                                                                                                                                                                                                                                        func (f IntSliceFlag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                                                                                          GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                                                                                          func (IntSliceFlag) GetValue

                                                                                                                                                                                                                                                                                                                                                                                                                          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 (IntSliceFlag) IsRequired

                                                                                                                                                                                                                                                                                                                                                                                                                            func (f IntSliceFlag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                                                                                              IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                                                                                              func (IntSliceFlag) String

                                                                                                                                                                                                                                                                                                                                                                                                                              func (f IntSliceFlag) String() string

                                                                                                                                                                                                                                                                                                                                                                                                                                String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                                                func (IntSliceFlag) TakesValue

                                                                                                                                                                                                                                                                                                                                                                                                                                func (f IntSliceFlag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                  TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                                                                  type MultiError

                                                                                                                                                                                                                                                                                                                                                                                                                                  type MultiError struct {
                                                                                                                                                                                                                                                                                                                                                                                                                                  	Errors []error
                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                    MultiError is an error that wraps multiple errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                    func NewMultiError

                                                                                                                                                                                                                                                                                                                                                                                                                                    func NewMultiError(err ...error) MultiError

                                                                                                                                                                                                                                                                                                                                                                                                                                      NewMultiError creates a new MultiError. Pass in one or more errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                      func (MultiError) Error

                                                                                                                                                                                                                                                                                                                                                                                                                                      func (m MultiError) Error() string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Error implements the error interface.

                                                                                                                                                                                                                                                                                                                                                                                                                                        type OnUsageErrorFunc

                                                                                                                                                                                                                                                                                                                                                                                                                                        type OnUsageErrorFunc func(context *Context, err error, isSubcommand bool) error

                                                                                                                                                                                                                                                                                                                                                                                                                                          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 RequiredFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                          type RequiredFlag interface {
                                                                                                                                                                                                                                                                                                                                                                                                                                          	Flag
                                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                                          	IsRequired() bool
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                                                                                                            type StringFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                            type StringFlag struct {
                                                                                                                                                                                                                                                                                                                                                                                                                                            	Name        string
                                                                                                                                                                                                                                                                                                                                                                                                                                            	Usage       string
                                                                                                                                                                                                                                                                                                                                                                                                                                            	EnvVar      string
                                                                                                                                                                                                                                                                                                                                                                                                                                            	FilePath    string
                                                                                                                                                                                                                                                                                                                                                                                                                                            	Required    bool
                                                                                                                                                                                                                                                                                                                                                                                                                                            	Hidden      bool
                                                                                                                                                                                                                                                                                                                                                                                                                                            	TakesFile   bool
                                                                                                                                                                                                                                                                                                                                                                                                                                            	Value       string
                                                                                                                                                                                                                                                                                                                                                                                                                                            	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 Ignores errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                func (StringFlag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                                                                                                                                func (f StringFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                                                                                                                                  ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (StringFlag) GetName

                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (f StringFlag) GetName() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (StringFlag) GetUsage

                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (f StringFlag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (StringFlag) GetValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 (StringFlag) IsRequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                        func (f StringFlag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                          IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (StringFlag) String

                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (f StringFlag) String() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                            String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (StringFlag) TakesValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (f StringFlag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                              TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                                                                                              type StringSlice

                                                                                                                                                                                                                                                                                                                                                                                                                                                              type StringSlice []string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                StringSlice is an opaque type for []string to satisfy flag.Value and flag.Getter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (*StringSlice) Get

                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (f *StringSlice) Get() interface{}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get returns the slice of strings set by this flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (*StringSlice) Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (f *StringSlice) Set(value string) error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set appends the string value to the list of values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (*StringSlice) String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (f *StringSlice) String() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (*StringSlice) Value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (f *StringSlice) Value() []string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Value returns the slice of strings set by this flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type StringSliceFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type StringSliceFlag struct {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	Name      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	Usage     string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	EnvVar    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	FilePath  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	Required  bool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	Hidden    bool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	TakesFile bool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        	Value     *StringSlice
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          StringSliceFlag is a flag with type *StringSlice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (StringSliceFlag) Apply

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (f StringSliceFlag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (StringSliceFlag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (f StringSliceFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              func (StringSliceFlag) GetName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              func (f StringSliceFlag) GetName() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (StringSliceFlag) GetUsage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (f StringSliceFlag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (StringSliceFlag) GetValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 (StringSliceFlag) IsRequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (f StringSliceFlag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (StringSliceFlag) String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (f StringSliceFlag) String() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        func (StringSliceFlag) TakesValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        func (f StringSliceFlag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Uint64Flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Uint64Flag struct {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	Name        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	Usage       string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	EnvVar      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	FilePath    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	Required    bool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	Hidden      bool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	Value       uint64
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	Destination *uint64
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Uint64Flag is a flag with type uint64

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (Uint64Flag) Apply

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (f Uint64Flag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              func (Uint64Flag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              func (f Uint64Flag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (Uint64Flag) GetName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (f Uint64Flag) GetName() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (Uint64Flag) GetUsage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (f Uint64Flag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (Uint64Flag) GetValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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 (Uint64Flag) IsRequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (f Uint64Flag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        func (Uint64Flag) String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        func (f Uint64Flag) String() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (Uint64Flag) TakesValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (f Uint64Flag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type UintFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type UintFlag struct {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Name        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Usage       string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	EnvVar      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	FilePath    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Required    bool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Hidden      bool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Value       uint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Destination *uint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              UintFlag is a flag with type uint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              func (UintFlag) Apply

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              func (f UintFlag) Apply(set *flag.FlagSet)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Apply populates the flag given the flag set and environment Ignores errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (UintFlag) ApplyWithError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                func (f UintFlag) ApplyWithError(set *flag.FlagSet) error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ApplyWithError populates the flag given the flag set and environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (UintFlag) GetName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  func (f UintFlag) GetName() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GetName returns the name of the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (UintFlag) GetUsage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    func (f UintFlag) GetUsage() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetUsage returns the usage string for the flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (UintFlag) GetValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      func (f UintFlag) GetValue() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GetValue returns the flags value as string representation and an empty string if the flag takes no value at all.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        func (UintFlag) IsRequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        func (f UintFlag) IsRequired() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IsRequired returns whether or not the flag is required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (UintFlag) String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          func (f UintFlag) String() string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            String returns a readable representation of this value (for usage defaults)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (UintFlag) TakesValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            func (f UintFlag) TakesValue() bool

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              TakesValue returns true of the flag takes a value, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Directories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Path Synopsis