Package cli

func main() {
	(&cli.App{}).Run(os.Args)
}

func main() {
	app := &cli.App{
  		Name: "greet",
  		Usage: "say a greeting",
  		Action: func(c *cli.Context) error {
  			fmt.Println("Greetings")
  			return nil
  		},
	}

	app.Run(os.Args)
}

Variables

var (
    SuggestFlag               SuggestFlagFunc    = nil // initialized in suggestions.go unless built with urfave_cli_no_suggest
    SuggestCommand            SuggestCommandFunc = nil // initialized in suggestions.go unless built with urfave_cli_no_suggest
    SuggestDidYouMeanTemplate string             = suggestDidYouMeanTemplate
)

AppHelpTemplate is the text template for the Default help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.

var AppHelpTemplate = `NAME:
   {{template "helpNameTemplate" .}}

USAGE:
   {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}{{if .Args}}[arguments...]{{end}}{{end}}{{end}}{{if .Version}}{{if not .HideVersion}}

VERSION:
   {{.Version}}{{end}}{{end}}{{if .Description}}

DESCRIPTION:
   {{template "descriptionTemplate" .}}{{end}}
{{- if len .Authors}}

AUTHOR{{template "authorsTemplate" .}}{{end}}{{if .VisibleCommands}}

COMMANDS:{{template "visibleCommandCategoryTemplate" .}}{{end}}{{if .VisibleFlagCategories}}

GLOBAL OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}}

GLOBAL OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}{{if .Copyright}}

COPYRIGHT:
   {{template "copyrightTemplate" .}}{{end}}
`

CommandHelpTemplate is the text template for the command help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.

var CommandHelpTemplate = `NAME:
   {{template "helpNameTemplate" .}}

USAGE:
   {{template "usageTemplate" .}}{{if .Category}}

CATEGORY:
   {{.Category}}{{end}}{{if .Description}}

DESCRIPTION:
   {{template "descriptionTemplate" .}}{{end}}{{if .VisibleFlagCategories}}

OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}}

OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}
`

ErrWriter is used to write errors to the user. This can be anything implementing the io.Writer interface and defaults to os.Stderr.

var ErrWriter io.Writer = os.Stderr

var FishCompletionTemplate = `# {{ .App.Name }} fish shell completion

function __fish_{{ .App.Name }}_no_subcommand --description 'Test if there has been any subcommand yet'
    for i in (commandline -opc)
        if contains -- $i{{ range $v := .AllCommands }} {{ $v }}{{ end }}
            return 1
        end
    end
    return 0
end

{{ range $v := .Completions }}{{ $v }}
{{ end }}`

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.

var HelpPrinter helpPrinter = printHelp

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.

In the default implementation, if the customFuncs argument contains a "wrapAt" key, which is a function which takes no arguments and returns an int, this int value will be used to produce a "wrap" function used by the default template to wrap long lines.

var HelpPrinterCustom helpPrinterCustom = printHelpCustom

var MarkdownDocTemplate = `{{if gt .SectionNum 0}}% {{ .App.Name }} {{ .SectionNum }}

{{end}}# NAME

{{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }}

# SYNOPSIS

{{ .App.Name }}
{{ if .SynopsisArgs }}
` + "```" + `
{{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + `
{{ end }}{{ if .App.Description }}
# DESCRIPTION

{{ .App.Description }}
{{ end }}
**Usage**:

` + "```" + `{{ if .App.UsageText }}
{{ .App.UsageText }}
{{ else }}
{{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
{{ end }}` + "```" + `
{{ if .GlobalArgs }}
# GLOBAL OPTIONS
{{ range $v := .GlobalArgs }}
{{ $v }}{{ end }}
{{ end }}{{ if .Commands }}
# COMMANDS
{{ range $v := .Commands }}
{{ $v }}{{ end }}{{ end }}`

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

var OsExiter = os.Exit

SubcommandHelpTemplate is the text template for the subcommand help topic. cli.go uses text/template to render templates. You can render custom help text by setting this variable.

var SubcommandHelpTemplate = `NAME:
   {{template "helpNameTemplate" .}}

USAGE:
   {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}{{if .Args}}[arguments...]{{end}}{{end}}{{end}}{{if .Description}}

DESCRIPTION:
   {{template "descriptionTemplate" .}}{{end}}{{if .VisibleCommands}}

COMMANDS:{{template "visibleCommandCategoryTemplate" .}}{{end}}{{if .VisibleFlagCategories}}

OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}}

OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}
`

VersionPrinter prints the version for the App

var VersionPrinter = printVersion

func DefaultAppComplete ¶

func DefaultAppComplete(cCtx *Context)

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

func DefaultCompleteWithFlags ¶

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

func FlagNames ¶

func FlagNames(name string, aliases []string) []string

func HandleAction ¶

func HandleAction(action interface{}, cCtx *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 handles errors implementing ExitCoder by printing their message and calling OsExiter with the given exit code.

If the given error instead implements MultiError, each error will be checked for the ExitCoder interface, and OsExiter will be called with the last exit code found, or exit code 1 if no ExitCoder is found.

This function is the default error-handling behavior for an App.

func ShowAppHelp ¶

func ShowAppHelp(cCtx *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(cCtx *Context)

ShowCompletions prints the lists of commands within a given context

func ShowSubcommandHelp ¶

func ShowSubcommandHelp(cCtx *Context) error

ShowSubcommandHelp prints help for the given subcommand

func ShowSubcommandHelpAndExit ¶

func ShowSubcommandHelpAndExit(c *Context, exitCode int)

ShowSubcommandHelpAndExit - Prints help for the given subcommand and exits with exit code.

func ShowVersion ¶

func ShowVersion(cCtx *Context)

ShowVersion prints the version number of the App

type ActionFunc ¶

ActionFunc is the action to execute when no subcommands are specified

type ActionFunc func(*Context) error

type ActionableFlag ¶

ActionableFlag is an interface that wraps Flag interface and RunAction operation.

type ActionableFlag interface {
    Flag
    RunAction(*Context) error
}

type AfterFunc ¶

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 AfterFunc func(*Context) error

type App ¶

App is the main structure of a cli application. It is recommended that an app be created with the cli.NewApp() function

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
    // Whether this command supports arguments
    Args bool
    // Description of the program argument format.
    ArgsUsage string
    // Version of the program
    Version string
    // Description of the program
    Description string
    // DefaultCommand is the (optional) name of a command
    // to run if no command names are passed as CLI arguments.
    DefaultCommand 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 and help flag
    HideHelp bool
    // Boolean to hide built-in help command but keep help flag.
    // Ignored if HideHelp is true.
    HideHelpCommand bool
    // Boolean to hide built-in version flag and the VERSION section of help
    HideVersion bool

    // An action to execute when the shell completion flag is set
    BashComplete BashCompleteFunc
    // An action to execute before any subcommands are run, but after the context is ready
    // If a non-nil error is returned, no subcommands are run
    Before BeforeFunc
    // An action to execute after any subcommands are run, but after the subcommand has finished
    // It is run even if Action() panics
    After AfterFunc
    // The action to execute when no subcommands are specified
    Action ActionFunc
    // Execute this function if the proper command cannot be found
    CommandNotFound CommandNotFoundFunc
    // Execute this function if a usage error occurs
    OnUsageError OnUsageErrorFunc
    // Execute this function when an invalid flag is accessed from the context
    InvalidFlagAccessHandler InvalidFlagAccessFunc
    // Compilation date
    Compiled time.Time
    // List of all authors who contributed
    Authors []*Author
    // Copyright of the binary if any
    Copyright string
    // Reader reader to write input to (useful for tests)
    Reader io.Reader
    // Writer writer to write output to
    Writer io.Writer
    // ErrWriter writes error output
    ErrWriter io.Writer
    // ExitErrHandler processes any error encountered while running an App before
    // it is returned to the caller. If no function is provided, HandleExitCoder
    // is used as the default behavior.
    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
    // SliceFlagSeparator is used to customize the separator for SliceFlag, the default is ","
    SliceFlagSeparator string
    // DisableSliceFlagSeparator is used to disable SliceFlagSeparator, the default is false
    DisableSliceFlagSeparator 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
    // Enable suggestions for commands and flags
    Suggest bool
    // Allows global flags set by libraries which use flag.XXXVar(...) directly
    // to be parsed through this library
    AllowExtFlags bool
    // Treat all flags as normal arguments if true
    SkipFlagParsing bool
    // contains filtered or unexported fields
}

func NewApp ¶

func NewApp() *App

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

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

// set args for examples sake
os.Args = []string{"greet", "--name", "Jeremy"}

app := &App{
    Name: "greet",
    Flags: []Flag{
        &StringFlag{Name: "name", Value: "bob", Usage: "a name to say"},
    },
    Action: func(c *Context) error {
        fmt.Printf("Hello %v\n", c.String("name"))
        return nil
    },
    UsageText: "app [first_arg] [second_arg]",
    Authors:   []*Author{{Name: "Oliver Allen", Email: "oliver@toyshop.example.com"}},
}

if err := app.Run(os.Args); err != nil {
    return
}

Hello Jeremy

// set args for examples sake
os.Args = []string{"greet", "help"}

app := &App{
    Name:        "greet",
    Version:     "0.1.0",
    Args:        true,
    Description: "This is how we describe greet the app",
    Authors: []*Author{
        {Name: "Harrison", Email: "harrison@lolwut.com"},
        {Name: "Oliver Allen", Email: "oliver@toyshop.com"},
    },
    Flags: []Flag{
        &StringFlag{Name: "name", Value: "bob", Usage: "a name to say"},
    },
    Commands: []*Command{
        {
            Name:        "describeit",
            Aliases:     []string{"d"},
            Usage:       "use it to see a description",
            Description: "This is how we describe describeit the function",
            Action: func(c *Context) error {
                fmt.Printf("i like to describe things")
                return nil
            },
        },
    },
}
_ = app.Run(os.Args)

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

os.Setenv("SHELL", "bash")
os.Args = []string{"greet", "--generate-bash-completion"}

app := &App{
    Name:                 "greet",
    EnableBashCompletion: true,
    Commands: []*Command{
        {
            Name:        "describeit",
            Aliases:     []string{"d"},
            Usage:       "use it to see a description",
            Description: "This is how we describe describeit the function",
            Action: func(c *Context) error {
                fmt.Printf("i like to describe things")
                return nil
            },
        }, {
            Name:        "next",
            Usage:       "next example",
            Description: "more stuff to see when generating shell completion",
            Action: func(c *Context) error {
                fmt.Printf("the next example")
                return nil
            },
        },
    },
}

_ = app.Run(os.Args)

describeit
d
next
help
h

// set args for examples sake
os.Args = []string{"greet", "h", "describeit"}

app := &App{
    Name: "greet",
    Args: true,
    Flags: []Flag{
        &StringFlag{Name: "name", Value: "bob", Usage: "a name to say"},
    },
    Commands: []*Command{
        {
            Name:        "describeit",
            Aliases:     []string{"d"},
            Usage:       "use it to see a description",
            Description: "This is how we describe describeit the function",
            Action: func(c *Context) error {
                fmt.Printf("i like to describe things")
                return nil
            },
        },
    },
}
_ = app.Run(os.Args)

NAME:
   greet describeit - use it to see a description

USAGE:
   greet describeit [command options] [arguments...]

DESCRIPTION:
   This is how we describe describeit the function

OPTIONS:
   --help, -h  show help

app := App{}
app.Name = "greet"
app.Args = true
_ = app.Run([]string{"greet"})

NAME:
   greet - A new cli application

USAGE:
   greet [global options] command [command options] [arguments...]

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help

// set args for examples sake
os.Args = []string{"multi_values",
    "--stringSclice", "parsed1,parsed2", "--stringSclice", "parsed3,parsed4",
    "--float64Sclice", "13.3,14.4", "--float64Sclice", "15.5,16.6",
    "--int64Sclice", "13,14", "--int64Sclice", "15,16",
    "--intSclice", "13,14", "--intSclice", "15,16",
}
app := NewApp()
app.Name = "multi_values"
app.Flags = []Flag{
    &StringSliceFlag{Name: "stringSclice"},
    &Float64SliceFlag{Name: "float64Sclice"},
    &Int64SliceFlag{Name: "int64Sclice"},
    &IntSliceFlag{Name: "intSclice"},
}
app.Action = func(ctx *Context) error {
    for i, v := range ctx.FlagNames() {
        fmt.Printf("%d-%s %#v\n", i, v, ctx.Value(v))
    }
    err := ctx.Err()
    fmt.Println("error:", err)
    return err
}

_ = app.Run(os.Args)

0-float64Sclice cli.Float64Slice{slice:[]float64{13.3, 14.4, 15.5, 16.6}, separator:cli.separatorSpec{sep:"", disabled:false, customized:false}, hasBeenSet:true}
1-int64Sclice cli.Int64Slice{slice:[]int64{13, 14, 15, 16}, separator:cli.separatorSpec{sep:"", disabled:false, customized:false}, hasBeenSet:true}
2-intSclice cli.IntSlice{slice:[]int{13, 14, 15, 16}, separator:cli.separatorSpec{sep:"", disabled:false, customized:false}, hasBeenSet:true}
3-stringSclice cli.StringSlice{slice:[]string{"parsed1", "parsed2", "parsed3", "parsed4"}, separator:cli.separatorSpec{sep:"", disabled:false, customized:false}, hasBeenSet:true, keepSpace:false}
error: <nil>

// set args for examples sake
os.Args = []string{"say", "hi", "english", "--name", "Jeremy"}
app := &App{
    Name: "say",
    Commands: []*Command{
        {
            Name:        "hello",
            Aliases:     []string{"hi"},
            Usage:       "use it to see a description",
            Description: "This is how we describe hello the function",
            Subcommands: []*Command{
                {
                    Name:        "english",
                    Aliases:     []string{"en"},
                    Usage:       "sends a greeting in english",
                    Description: "greets someone in english",
                    Flags: []Flag{
                        &StringFlag{
                            Name:  "name",
                            Value: "Bob",
                            Usage: "Name of the person to greet",
                        },
                    },
                    Action: func(c *Context) error {
                        fmt.Println("Hello,", c.String("name"))
                        return nil
                    },
                },
            },
        },
    },
}

_ = app.Run(os.Args)

Hello, Jeremy

app := &App{
    Name: "greet",
    Args: true,
    Commands: []*Command{
        {
            Name:        "describeit",
            Aliases:     []string{"d"},
            Usage:       "use it to see a description",
            Description: "This is how we describe describeit the function",
        },
    },
}
_ = app.Run([]string{"greet", "describeit"})

NAME:
   greet describeit - use it to see a description

USAGE:
   greet describeit [command options] [arguments...]

DESCRIPTION:
   This is how we describe describeit the function

OPTIONS:
   --help, -h  show help

// set args for examples sake
os.Args = []string{"greet", "--generate-bash-completion"}
_ = os.Setenv("SHELL", "/usr/bin/zsh")

app := NewApp()
app.Name = "greet"
app.EnableBashCompletion = true
app.Commands = []*Command{
    {
        Name:        "describeit",
        Aliases:     []string{"d"},
        Usage:       "use it to see a description",
        Description: "This is how we describe describeit the function",
        Action: func(c *Context) error {
            fmt.Printf("i like to describe things")
            return nil
        },
    }, {
        Name:        "next",
        Usage:       "next example",
        Description: "more stuff to see when generating bash completion",
        Action: func(c *Context) error {
            fmt.Printf("the next example")
            return nil
        },
    },
}

_ = app.Run(os.Args)

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 error code in the cli.ExitCoder

func (*App) RunAsSubcommand ¶

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

RunAsSubcommand is for legacy/compatibility purposes only. New code should only use App.RunContext. This function is slated to be removed in v3.

func (*App) RunContext ¶

func (a *App) RunContext(ctx context.Context, arguments []string) (err error)

RunContext is like Run except it takes a Context that will be passed to its commands and sub-commands. Through this, you can propagate timeouts and cancellation requests

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) ToManWithSection ¶

func (a *App) ToManWithSection(sectionNumber int) (string, error)

ToMan creates a man page string with section number 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) VisibleFlagCategories ¶

func (a *App) VisibleFlagCategories() []VisibleFlagCategory

VisibleFlagCategories returns a slice containing all the categories with the flags they contain

func (*App) VisibleFlags ¶

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

VisibleFlags returns a slice of the Flags with Hidden=false

type Args ¶

type Args interface {
    // Get returns the nth argument, or else a blank string
    Get(n int) string
    // First returns the first argument, or else a blank string
    First() string
    // Tail returns the rest of the arguments (not the first one)
    // or else an empty string slice
    Tail() []string
    // Len returns the length of the wrapped slice
    Len() int
    // Present checks if there are any arguments present
    Present() bool
    // Slice returns a copy of the internal slice
    Slice() []string
}

type Author ¶

Author represents someone who has contributed to a cli project.

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

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 ¶

BashCompleteFunc is an action to execute when the shell completion flag is set

type BashCompleteFunc func(*Context)

type BeforeFunc ¶

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 BeforeFunc func(*Context) error

type BoolFlag ¶

BoolFlag is a flag with type bool

type BoolFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       bool
    Destination *bool

    Aliases []string
    EnvVars []string

    Count *int

    DisableDefaultText bool

    Action func(*Context, bool) error
    // contains filtered or unexported fields
}

func (*BoolFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*BoolFlag) Get ¶

func (f *BoolFlag) Get(ctx *Context) bool

Get returns the flag’s value in the given Context.

func (*BoolFlag) GetCategory ¶

func (f *BoolFlag) GetCategory() string

GetCategory returns the category for the flag

func (*BoolFlag) GetDefaultText ¶

func (f *BoolFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*BoolFlag) GetEnvVars ¶

func (f *BoolFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *BoolFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*BoolFlag) IsVisible ¶

func (f *BoolFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*BoolFlag) Names ¶

func (f *BoolFlag) Names() []string

Names returns the names of the flag

func (*BoolFlag) RunAction ¶

func (f *BoolFlag) RunAction(c *Context) error

RunAction executes flag action if set

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 CategorizableFlag ¶

CategorizableFlag is an interface that allows us to potentially use a flag in a categorized representation.

type CategorizableFlag interface {
    VisibleFlag

    GetCategory() string
}

type Command ¶

Command is a subcommand for a cli.App.

type Command struct {
    // The name of the command
    Name string
    // A list of aliases for the command
    Aliases []string
    // A short description of the usage of this command
    Usage string
    // Custom text to show on USAGE section of help
    UsageText string
    // A longer explanation of how the command works
    Description string
    // Whether this command supports arguments
    Args bool
    // A short description of the arguments of this command
    ArgsUsage string
    // The category the command is part of
    Category string
    // The function to call when checking for bash command completions
    BashComplete BashCompleteFunc
    // An action to execute before any sub-subcommands are run, but after the context is ready
    // If a non-nil error is returned, no sub-subcommands are run
    Before BeforeFunc
    // An action to execute after any subcommands are run, but after the subcommand has finished
    // It is run even if Action() panics
    After AfterFunc
    // The function to call when this command is invoked
    Action ActionFunc
    // Execute this function if a usage error occurs.
    OnUsageError OnUsageErrorFunc
    // List of child commands
    Subcommands []*Command
    // List of flags to parse
    Flags []Flag

    // Treat all flags as normal arguments if true
    SkipFlagParsing bool
    // Boolean to hide built-in help command and help flag
    HideHelp bool
    // Boolean to hide built-in help command but keep help flag
    // Ignored if HideHelp is true.
    HideHelpCommand 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
}

func (*Command) Command ¶

func (cmd *Command) Command(name string) *Command

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 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(cCtx *Context, arguments ...string) (err error)

func (*Command) VisibleCategories ¶

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

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

func (*Command) VisibleCommands ¶

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

VisibleCommands returns a slice of the Commands with Hidden=false

func (*Command) VisibleFlagCategories ¶

func (c *Command) VisibleFlagCategories() []VisibleFlagCategory

VisibleFlagCategories returns a slice containing all the visible flag categories with the flags they contain

func (*Command) VisibleFlags ¶

func (c *Command) VisibleFlags() []Flag

VisibleFlags returns a slice of the Flags with Hidden=false

type CommandCategories ¶

CommandCategories interface allows for category manipulation

type CommandCategories interface {
    // AddCommand adds a command to a category, creating a new category if necessary.
    AddCommand(category string, command *Command)
    // Categories returns a slice of categories sorted by name
    Categories() []CommandCategory
}

type CommandCategory ¶

CommandCategory is a category containing commands.

type CommandCategory interface {
    // Name returns the category name string
    Name() string
    // VisibleCommands returns a slice of the Commands with Hidden=false
    VisibleCommands() []*Command
}

type CommandNotFoundFunc ¶

CommandNotFoundFunc is executed if the proper command cannot be found

type CommandNotFoundFunc func(*Context, string)

type Commands ¶

type Commands []*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 ¶

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.

type Context struct {
    context.Context
    App     *App
    Command *Command
    // contains filtered or unexported fields
}

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 (cCtx *Context) Args() Args

Args returns the command line arguments associated with the context.

func (*Context) Bool ¶

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

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

func (*Context) Count ¶

func (cCtx *Context) Count(name string) int

Count returns the num of occurrences of this flag

func (*Context) Duration ¶

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

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

func (*Context) FlagNames ¶

func (cCtx *Context) FlagNames() []string

FlagNames returns a slice of flag names used by the this context and all of its parent contexts.

func (*Context) Float64 ¶

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

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

func (*Context) Float64Slice ¶

func (cCtx *Context) Float64Slice(name string) []float64

Float64Slice looks up the value of a local Float64SliceFlag, returns nil if not found

func (*Context) Generic ¶

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

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

func (*Context) Int ¶

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

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

func (*Context) Int64 ¶

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

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

func (*Context) Int64Slice ¶

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

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

func (*Context) IntSlice ¶

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

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

func (*Context) IsSet ¶

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

IsSet determines if the flag was actually set

func (*Context) Lineage ¶

func (cCtx *Context) Lineage() []*Context

Lineage returns *this* context and all of its ancestor contexts in order from child to parent

func (*Context) LocalFlagNames ¶

func (cCtx *Context) LocalFlagNames() []string

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

func (*Context) NArg ¶

func (cCtx *Context) NArg() int

NArg returns the number of the command line arguments.

func (*Context) NumFlags ¶

func (cCtx *Context) NumFlags() int

NumFlags returns the number of flags set

func (*Context) Path ¶

func (cCtx *Context) Path(name string) string

Path looks up the value of a local PathFlag, returns "" if not found

func (*Context) Set ¶

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

Set sets a context flag to a value.

func (*Context) String ¶

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

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

func (*Context) StringSlice ¶

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

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

func (*Context) Timestamp ¶

func (cCtx *Context) Timestamp(name string) *time.Time

Timestamp gets the timestamp from a flag name

func (*Context) Uint ¶

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

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

func (*Context) Uint64 ¶

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

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

func (*Context) Uint64Slice ¶

func (cCtx *Context) Uint64Slice(name string) []uint64

Uint64Slice looks up the value of a local Uint64SliceFlag, returns nil if not found

func (*Context) UintSlice ¶

func (cCtx *Context) UintSlice(name string) []uint

UintSlice looks up the value of a local UintSliceFlag, returns nil if not found

func (*Context) Value ¶

func (cCtx *Context) Value(name string) interface{}

Value returns the value of the flag corresponding to `name`

type Countable ¶

Countable is an interface to enable detection of flag values which support repetitive flags

type Countable interface {
    Count() int
}

type DocGenerationFlag ¶

DocGenerationFlag is an interface that allows documentation generation for the flag

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

    // GetDefaultText returns the default text for this flag
    GetDefaultText() string

    // GetEnvVars returns the env vars for this flag
    GetEnvVars() []string
}

type DocGenerationSliceFlag ¶

DocGenerationSliceFlag extends DocGenerationFlag for slice-based flags.

type DocGenerationSliceFlag interface {
    DocGenerationFlag

    // IsSliceFlag returns true for flags that can be given multiple times.
    IsSliceFlag() bool
}

type DurationFlag ¶

DurationFlag is a flag with type time.Duration

type DurationFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       time.Duration
    Destination *time.Duration

    Aliases []string
    EnvVars []string

    Action func(*Context, time.Duration) error
    // contains filtered or unexported fields
}

func (*DurationFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*DurationFlag) Get ¶

func (f *DurationFlag) Get(ctx *Context) time.Duration

Get returns the flag’s value in the given Context.

func (*DurationFlag) GetCategory ¶

func (f *DurationFlag) GetCategory() string

GetCategory returns the category for the flag

func (*DurationFlag) GetDefaultText ¶

func (f *DurationFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*DurationFlag) GetEnvVars ¶

func (f *DurationFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *DurationFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*DurationFlag) IsVisible ¶

func (f *DurationFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*DurationFlag) Names ¶

func (f *DurationFlag) Names() []string

Names returns the names of the flag

func (*DurationFlag) RunAction ¶

func (f *DurationFlag) RunAction(c *Context) error

RunAction executes flag action if set

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 ¶

ErrorFormatter is the interface that will suitably format the error output

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

type ExitCoder ¶

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

type ExitCoder interface {
    error
    ExitCode() int
}

func Exit ¶

func Exit(message interface{}, exitCode int) ExitCoder

Exit wraps a message and exit code into an error, which by default is handled with a call to os.Exit during default error handling.

This is the simplest way to trigger a non-zero exit code for an App without having to call os.Exit manually. During testing, this behavior can be avoided by overriding the ExitErrHandler function on an App or the package-global OsExiter function.

func NewExitError ¶

func NewExitError(message interface{}, exitCode int) ExitCoder

NewExitError calls Exit to create a new ExitCoder.

Deprecated: This function is a duplicate of Exit and will eventually be removed.

type ExitErrHandlerFunc ¶

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

type ExitErrHandlerFunc func(cCtx *Context, err error)

type Flag ¶

Flag is a common interface related to parsing flags in cli. For more advanced flag parsing techniques, it is recommended that this interface be implemented.

type Flag interface {
    fmt.Stringer
    // Apply Flag settings to the given flag set
    Apply(*flag.FlagSet) error
    Names() []string
    IsSet() bool
}

BashCompletionFlag enables bash-completion for all commands and subcommands

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

HelpFlag prints the help for all commands and subcommands. Set to nil to disable the flag. The subcommand will still be added unless HideHelp or HideHelpCommand is set to true.

var HelpFlag Flag = &BoolFlag{
    Name:               "help",
    Aliases:            []string{"h"},
    Usage:              "show help",
    DisableDefaultText: true,
}

VersionFlag prints the version for the application

var VersionFlag Flag = &BoolFlag{
    Name:               "version",
    Aliases:            []string{"v"},
    Usage:              "print the version",
    DisableDefaultText: true,
}

type FlagCategories ¶

FlagCategories interface allows for category manipulation

type FlagCategories interface {
    // AddFlags adds a flag to a category, creating a new category if necessary.
    AddFlag(category string, fl Flag)
    // VisibleCategories returns a slice of visible flag categories sorted by name
    VisibleCategories() []VisibleFlagCategory
}

type FlagEnvHintFunc ¶

FlagEnvHintFunc is used by the default FlagStringFunc to annotate flag help with the environment variable details.

type FlagEnvHintFunc func(envVars []string, str string) string

FlagEnvHinter annotates flag help message with the environment variable details. This is used by the default FlagStringer.

var FlagEnvHinter FlagEnvHintFunc = withEnvHint

type FlagFileHintFunc ¶

FlagFileHintFunc is used by the default FlagStringFunc to annotate flag help with the file path details.

type FlagFileHintFunc func(filePath, str string) string

FlagFileHinter annotates flag help message with the environment variable details. This is used by the default FlagStringer.

var FlagFileHinter FlagFileHintFunc = withFileHint

type FlagNamePrefixFunc ¶

FlagNamePrefixFunc is used by the default FlagStringFunc to create prefix text for a flag's full name.

type FlagNamePrefixFunc func(fullName []string, placeholder string) string

FlagNamePrefixer converts a full flag name and its placeholder into the help message flag prefix. This is used by the default FlagStringer.

var FlagNamePrefixer FlagNamePrefixFunc = prefixedNames

type FlagStringFunc ¶

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

type FlagStringFunc func(Flag) string

FlagStringer converts a flag definition to a string. This is used by help to display a flag.

var FlagStringer FlagStringFunc = stringifyFlag

type FlagsByName ¶

FlagsByName is a slice of Flag.

type FlagsByName []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 ¶

Float64Flag is a flag with type float64

type Float64Flag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       float64
    Destination *float64

    Aliases []string
    EnvVars []string

    Action func(*Context, float64) error
    // contains filtered or unexported fields
}

func (*Float64Flag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*Float64Flag) Get ¶

func (f *Float64Flag) Get(ctx *Context) float64

Get returns the flag’s value in the given Context.

func (*Float64Flag) GetCategory ¶

func (f *Float64Flag) GetCategory() string

GetCategory returns the category for the flag

func (*Float64Flag) GetDefaultText ¶

func (f *Float64Flag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Float64Flag) GetEnvVars ¶

func (f *Float64Flag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *Float64Flag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*Float64Flag) IsVisible ¶

func (f *Float64Flag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*Float64Flag) Names ¶

func (f *Float64Flag) Names() []string

Names returns the names of the flag

func (*Float64Flag) RunAction ¶

func (f *Float64Flag) RunAction(c *Context) error

RunAction executes flag action if set

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 Float64Slice ¶

Float64Slice wraps []float64 to satisfy flag.Value

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

func NewFloat64Slice ¶

func NewFloat64Slice(defaults ...float64) *Float64Slice

NewFloat64Slice makes a *Float64Slice with default values

func (*Float64Slice) Get ¶

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

Get returns the slice of float64s set by this flag

func (*Float64Slice) Serialize ¶

func (f *Float64Slice) Serialize() string

Serialize allows Float64Slice to fulfill Serializer

func (*Float64Slice) Set ¶

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

Set parses the value into a float64 and appends it to the list of values

func (*Float64Slice) String ¶

func (f *Float64Slice) String() string

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

func (*Float64Slice) Value ¶

func (f *Float64Slice) Value() []float64

Value returns the slice of float64s set by this flag

func (*Float64Slice) WithSeparatorSpec ¶

func (f *Float64Slice) WithSeparatorSpec(spec separatorSpec)

type Float64SliceFlag ¶

Float64SliceFlag is a flag with type *Float64Slice

type Float64SliceFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       *Float64Slice
    Destination *Float64Slice

    Aliases []string
    EnvVars []string

    Action func(*Context, []float64) error
    // contains filtered or unexported fields
}

func (*Float64SliceFlag) Apply ¶

func (f *Float64SliceFlag) Apply(set *flag.FlagSet) error

Apply populates the flag given the flag set and environment

func (*Float64SliceFlag) Get ¶

func (f *Float64SliceFlag) Get(ctx *Context) []float64

Get returns the flag’s value in the given Context.

func (*Float64SliceFlag) GetCategory ¶

func (f *Float64SliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*Float64SliceFlag) GetDefaultText ¶

func (f *Float64SliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Float64SliceFlag) GetDestination ¶

func (f *Float64SliceFlag) GetDestination() []float64

func (*Float64SliceFlag) GetEnvVars ¶

func (f *Float64SliceFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this flag

func (*Float64SliceFlag) GetUsage ¶

func (f *Float64SliceFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*Float64SliceFlag) GetValue ¶

func (f *Float64SliceFlag) GetValue() string

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

func (*Float64SliceFlag) IsRequired ¶

func (f *Float64SliceFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*Float64SliceFlag) IsSet ¶

func (f *Float64SliceFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*Float64SliceFlag) IsSliceFlag ¶

func (f *Float64SliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*Float64SliceFlag) IsVisible ¶

func (f *Float64SliceFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*Float64SliceFlag) Names ¶

func (f *Float64SliceFlag) Names() []string

Names returns the names of the flag

func (*Float64SliceFlag) RunAction ¶

func (f *Float64SliceFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*Float64SliceFlag) SetDestination ¶

func (f *Float64SliceFlag) SetDestination(slice []float64)

func (*Float64SliceFlag) SetValue ¶

func (f *Float64SliceFlag) SetValue(slice []float64)

func (*Float64SliceFlag) String ¶

func (f *Float64SliceFlag) String() string

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

func (*Float64SliceFlag) TakesValue ¶

func (f *Float64SliceFlag) TakesValue() bool

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

func (*Float64SliceFlag) WithSeparatorSpec ¶

func (f *Float64SliceFlag) WithSeparatorSpec(spec separatorSpec)

type Generic ¶

Generic is a generic parseable type identified by a specific flag

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

type GenericFlag ¶

GenericFlag is a flag with type Generic

type GenericFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       Generic
    Destination Generic

    Aliases []string
    EnvVars []string

    TakesFile bool

    Action func(*Context, interface{}) error
    // contains filtered or unexported fields
}

func (*GenericFlag) Apply ¶

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

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

func (*GenericFlag) Get ¶

func (f *GenericFlag) Get(ctx *Context) interface{}

Get returns the flag’s value in the given Context.

func (*GenericFlag) GetCategory ¶

func (f *GenericFlag) GetCategory() string

GetCategory returns the category for the flag

func (*GenericFlag) GetDefaultText ¶

func (f *GenericFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*GenericFlag) GetEnvVars ¶

func (f *GenericFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *GenericFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*GenericFlag) IsVisible ¶

func (f *GenericFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*GenericFlag) Names ¶

func (f *GenericFlag) Names() []string

Names returns the names of the flag

func (*GenericFlag) RunAction ¶

func (f *GenericFlag) RunAction(c *Context) error

RunAction executes flag action if set

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 ¶

Int64Flag is a flag with type int64

type Int64Flag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       int64
    Destination *int64

    Aliases []string
    EnvVars []string

    Base int

    Action func(*Context, int64) error
    // contains filtered or unexported fields
}

func (*Int64Flag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*Int64Flag) Get ¶

func (f *Int64Flag) Get(ctx *Context) int64

Get returns the flag’s value in the given Context.

func (*Int64Flag) GetCategory ¶

func (f *Int64Flag) GetCategory() string

GetCategory returns the category for the flag

func (*Int64Flag) GetDefaultText ¶

func (f *Int64Flag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Int64Flag) GetEnvVars ¶

func (f *Int64Flag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *Int64Flag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*Int64Flag) IsVisible ¶

func (f *Int64Flag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*Int64Flag) Names ¶

func (f *Int64Flag) Names() []string

Names returns the names of the flag

func (*Int64Flag) RunAction ¶

func (f *Int64Flag) RunAction(c *Context) error

RunAction executes flag action if set

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 ¶

Int64Slice wraps []int64 to satisfy flag.Value

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

func NewInt64Slice ¶

func NewInt64Slice(defaults ...int64) *Int64Slice

NewInt64Slice makes an *Int64Slice with default values

func (*Int64Slice) Get ¶

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

Get returns the slice of ints set by this flag

func (*Int64Slice) Serialize ¶

func (i *Int64Slice) Serialize() string

Serialize allows Int64Slice to fulfill Serializer

func (*Int64Slice) Set ¶

func (i *Int64Slice) Set(value string) error

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

func (*Int64Slice) String ¶

func (i *Int64Slice) String() string

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

func (*Int64Slice) Value ¶

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

Value returns the slice of ints set by this flag

func (*Int64Slice) WithSeparatorSpec ¶

func (i *Int64Slice) WithSeparatorSpec(spec separatorSpec)

type Int64SliceFlag ¶

Int64SliceFlag is a flag with type *Int64Slice

type Int64SliceFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       *Int64Slice
    Destination *Int64Slice

    Aliases []string
    EnvVars []string

    Action func(*Context, []int64) error
    // contains filtered or unexported fields
}

func (*Int64SliceFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*Int64SliceFlag) Get ¶

func (f *Int64SliceFlag) Get(ctx *Context) []int64

Get returns the flag’s value in the given Context.

func (*Int64SliceFlag) GetCategory ¶

func (f *Int64SliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*Int64SliceFlag) GetDefaultText ¶

func (f *Int64SliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Int64SliceFlag) GetDestination ¶

func (f *Int64SliceFlag) GetDestination() []int64

func (*Int64SliceFlag) GetEnvVars ¶

func (f *Int64SliceFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *Int64SliceFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*Int64SliceFlag) IsSliceFlag ¶

func (f *Int64SliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*Int64SliceFlag) IsVisible ¶

func (f *Int64SliceFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*Int64SliceFlag) Names ¶

func (f *Int64SliceFlag) Names() []string

Names returns the names of the flag

func (*Int64SliceFlag) RunAction ¶

func (f *Int64SliceFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*Int64SliceFlag) SetDestination ¶

func (f *Int64SliceFlag) SetDestination(slice []int64)

func (*Int64SliceFlag) SetValue ¶

func (f *Int64SliceFlag) SetValue(slice []int64)

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

func (*Int64SliceFlag) WithSeparatorSpec ¶

func (f *Int64SliceFlag) WithSeparatorSpec(spec separatorSpec)

type IntFlag ¶

IntFlag is a flag with type int

type IntFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       int
    Destination *int

    Aliases []string
    EnvVars []string

    Base int

    Action func(*Context, int) error
    // contains filtered or unexported fields
}

func (*IntFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*IntFlag) Get ¶

func (f *IntFlag) Get(ctx *Context) int

Get returns the flag’s value in the given Context.

func (*IntFlag) GetCategory ¶

func (f *IntFlag) GetCategory() string

GetCategory returns the category for the flag

func (*IntFlag) GetDefaultText ¶

func (f *IntFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*IntFlag) GetEnvVars ¶

func (f *IntFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *IntFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*IntFlag) IsVisible ¶

func (f *IntFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*IntFlag) Names ¶

func (f *IntFlag) Names() []string

Names returns the names of the flag

func (*IntFlag) RunAction ¶

func (f *IntFlag) RunAction(c *Context) error

RunAction executes flag action if set

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 ¶

IntSlice wraps []int to satisfy flag.Value

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

func NewIntSlice ¶

func NewIntSlice(defaults ...int) *IntSlice

NewIntSlice makes an *IntSlice with default values

func (*IntSlice) Get ¶

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

Get returns the slice of ints set by this flag

func (*IntSlice) Serialize ¶

func (i *IntSlice) Serialize() string

Serialize allows IntSlice to fulfill Serializer

func (*IntSlice) Set ¶

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

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

func (*IntSlice) SetInt ¶

func (i *IntSlice) SetInt(value int)

TODO: Consistently have specific Set function for Int64 and Float64 ? SetInt directly adds an integer to the list of values

func (*IntSlice) String ¶

func (i *IntSlice) String() string

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

func (*IntSlice) Value ¶

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

Value returns the slice of ints set by this flag

func (*IntSlice) WithSeparatorSpec ¶

func (i *IntSlice) WithSeparatorSpec(spec separatorSpec)

type IntSliceFlag ¶

IntSliceFlag is a flag with type *IntSlice

type IntSliceFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       *IntSlice
    Destination *IntSlice

    Aliases []string
    EnvVars []string

    Action func(*Context, []int) error
    // contains filtered or unexported fields
}

func (*IntSliceFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*IntSliceFlag) Get ¶

func (f *IntSliceFlag) Get(ctx *Context) []int

Get returns the flag’s value in the given Context.

func (*IntSliceFlag) GetCategory ¶

func (f *IntSliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*IntSliceFlag) GetDefaultText ¶

func (f *IntSliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*IntSliceFlag) GetDestination ¶

func (f *IntSliceFlag) GetDestination() []int

func (*IntSliceFlag) GetEnvVars ¶

func (f *IntSliceFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *IntSliceFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*IntSliceFlag) IsSliceFlag ¶

func (f *IntSliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*IntSliceFlag) IsVisible ¶

func (f *IntSliceFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*IntSliceFlag) Names ¶

func (f *IntSliceFlag) Names() []string

Names returns the names of the flag

func (*IntSliceFlag) RunAction ¶

func (f *IntSliceFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*IntSliceFlag) SetDestination ¶

func (f *IntSliceFlag) SetDestination(slice []int)

func (*IntSliceFlag) SetValue ¶

func (f *IntSliceFlag) SetValue(slice []int)

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

func (*IntSliceFlag) WithSeparatorSpec ¶

func (f *IntSliceFlag) WithSeparatorSpec(spec separatorSpec)

type InvalidFlagAccessFunc ¶

InvalidFlagAccessFunc is executed when an invalid flag is accessed from the context.

type InvalidFlagAccessFunc func(*Context, string)

type MultiError ¶

MultiError is an error that wraps multiple errors.

type MultiError interface {
    error
    Errors() []error
}

type MultiFloat64Flag ¶

MultiFloat64Flag extends Float64SliceFlag with support for using slices directly, as Value and/or Destination. See also SliceFlag.

type MultiFloat64Flag = SliceFlag[*Float64SliceFlag, []float64, float64]

type MultiInt64Flag ¶

MultiInt64Flag extends Int64SliceFlag with support for using slices directly, as Value and/or Destination. See also SliceFlag.

type MultiInt64Flag = SliceFlag[*Int64SliceFlag, []int64, int64]

type MultiIntFlag ¶

MultiIntFlag extends IntSliceFlag with support for using slices directly, as Value and/or Destination. See also SliceFlag.

type MultiIntFlag = SliceFlag[*IntSliceFlag, []int, int]

type MultiStringFlag ¶

MultiStringFlag extends StringSliceFlag with support for using slices directly, as Value and/or Destination. See also SliceFlag.

type MultiStringFlag = SliceFlag[*StringSliceFlag, []string, string]

run := func(args ...string) {
    // add $0 (the command being run)
    args = append([]string{`-`}, args...)
    type CustomStringSlice []string
    type Config struct {
        FlagOne []string
        Two     CustomStringSlice
    }
    cfg := Config{
        Two: []string{
            `default value 1`,
            `default value 2`,
        },
    }
    if err := (&App{
        Flags: []Flag{
            &MultiStringFlag{
                Target: &StringSliceFlag{
                    Name:     `flag-one`,
                    Category: `category1`,
                    Usage:    `this is the first flag`,
                    Aliases:  []string{`1`},
                    EnvVars:  []string{`FLAG_ONE`},
                },
                Value:       cfg.FlagOne,
                Destination: &cfg.FlagOne,
            },
            &SliceFlag[*StringSliceFlag, CustomStringSlice, string]{
                Target: &StringSliceFlag{
                    Name:     `two`,
                    Category: `category2`,
                    Usage:    `this is the second flag`,
                    Aliases:  []string{`2`},
                    EnvVars:  []string{`TWO`},
                },
                Value:       cfg.Two,
                Destination: &cfg.Two,
            },
            &MultiStringFlag{
                Target: &StringSliceFlag{
                    Name:     `flag-three`,
                    Category: `category1`,
                    Usage:    `this is the third flag`,
                    Aliases:  []string{`3`},
                    EnvVars:  []string{`FLAG_THREE`},
                },
                Value: []string{`some value`},
            },
            &StringSliceFlag{
                Name:     `flag-four`,
                Category: `category2`,
                Usage:    `this is the fourth flag`,
                Aliases:  []string{`4`},
                EnvVars:  []string{`FLAG_FOUR`},
                Value:    NewStringSlice(`d1`, `d2`),
            },
        },
        Action: func(c *Context) error {
            fmt.Printf("Flag names: %q\n", c.FlagNames())
            fmt.Printf("Local flag names: %q\n", c.LocalFlagNames())
            fmt.Println(`Context values:`)
            for _, name := range [...]string{`flag-one`, `two`, `flag-three`, `flag-four`} {
                fmt.Printf("%q=%q\n", name, c.StringSlice(name))
            }
            fmt.Println(`Destination values:`)
            fmt.Printf("cfg.FlagOne=%q\n", cfg.FlagOne)
            fmt.Printf("cfg.Two=%q\n", cfg.Two)
            return nil
        },
        Writer:    os.Stdout,
        ErrWriter: os.Stdout,
        Name:      `app-name`,
    }).Run(args); err != nil {
        panic(err)
    }
}

fmt.Printf("Show defaults...\n\n")
run()

fmt.Printf("---\nSetting all flags via command line...\n\n")
allFlagsArgs := []string{
    `-1`, `v 1`,
    `-1`, `v 2`,
    `-2`, `v 3`,
    `-2`, `v 4`,
    `-3`, `v 5`,
    `-3`, `v 6`,
    `-4`, `v 7`,
    `-4`, `v 8`,
}
run(allFlagsArgs...)

func() {
    defer resetEnv(os.Environ())
    os.Clearenv()
    for _, args := range [...][2]string{
        {`FLAG_ONE`, `v 9, v 10`},
        {`TWO`, `v 11, v 12`},
        {`FLAG_THREE`, `v 13, v 14`},
        {`FLAG_FOUR`, `v 15, v 16`},
    } {
        if err := os.Setenv(args[0], args[1]); err != nil {
            panic(err)
        }
    }

    fmt.Printf("---\nSetting all flags via environment...\n\n")
    run()

    fmt.Printf("---\nWith the same environment + args from the previous example...\n\n")
    run(allFlagsArgs...)
}()

Show defaults...

Flag names: []
Local flag names: []
Context values:
"flag-one"=[]
"two"=["default value 1" "default value 2"]
"flag-three"=["some value"]
"flag-four"=["d1" "d2"]
Destination values:
cfg.FlagOne=[]
cfg.Two=["default value 1" "default value 2"]
---
Setting all flags via command line...

Flag names: ["1" "2" "3" "4" "flag-four" "flag-one" "flag-three" "two"]
Local flag names: ["1" "2" "3" "4" "flag-four" "flag-one" "flag-three" "two"]
Context values:
"flag-one"=["v 1" "v 2"]
"two"=["v 3" "v 4"]
"flag-three"=["v 5" "v 6"]
"flag-four"=["v 7" "v 8"]
Destination values:
cfg.FlagOne=["v 1" "v 2"]
cfg.Two=["v 3" "v 4"]
---
Setting all flags via environment...

Flag names: ["flag-one" "1" "two" "2" "flag-three" "3" "flag-four" "4"]
Local flag names: ["flag-one" "1" "two" "2" "flag-three" "3" "flag-four" "4"]
Context values:
"flag-one"=["v 9" "v 10"]
"two"=["v 11" "v 12"]
"flag-three"=["v 13" "v 14"]
"flag-four"=["v 15" "v 16"]
Destination values:
cfg.FlagOne=["v 9" "v 10"]
cfg.Two=["v 11" "v 12"]
---
With the same environment + args from the previous example...

Flag names: ["1" "2" "3" "4" "flag-four" "flag-one" "flag-three" "two"]
Local flag names: ["1" "2" "3" "4" "flag-four" "flag-one" "flag-three" "two"]
Context values:
"flag-one"=["v 1" "v 2"]
"two"=["v 3" "v 4"]
"flag-three"=["v 5" "v 6"]
"flag-four"=["v 7" "v 8"]
Destination values:
cfg.FlagOne=["v 1" "v 2"]
cfg.Two=["v 3" "v 4"]

type OnUsageErrorFunc ¶

OnUsageErrorFunc is executed if a 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 OnUsageErrorFunc func(cCtx *Context, err error, isSubcommand bool) error

type Path ¶

type Path = string

type PathFlag ¶

PathFlag is a flag with type Path

type PathFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       Path
    Destination *Path

    Aliases []string
    EnvVars []string

    TakesFile bool

    Action func(*Context, Path) error
    // contains filtered or unexported fields
}

func (*PathFlag) Apply ¶

func (f *PathFlag) Apply(set *flag.FlagSet) error

Apply populates the flag given the flag set and environment

func (*PathFlag) Get ¶

func (f *PathFlag) Get(ctx *Context) string

Get returns the flag’s value in the given Context.

func (*PathFlag) GetCategory ¶

func (f *PathFlag) GetCategory() string

GetCategory returns the category for the flag

func (*PathFlag) GetDefaultText ¶

func (f *PathFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*PathFlag) GetEnvVars ¶

func (f *PathFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this flag

func (*PathFlag) GetUsage ¶

func (f *PathFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*PathFlag) GetValue ¶

func (f *PathFlag) GetValue() string

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

func (*PathFlag) IsRequired ¶

func (f *PathFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*PathFlag) IsSet ¶

func (f *PathFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*PathFlag) IsVisible ¶

func (f *PathFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*PathFlag) Names ¶

func (f *PathFlag) Names() []string

Names returns the names of the flag

func (*PathFlag) RunAction ¶

func (f *PathFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*PathFlag) String ¶

func (f *PathFlag) String() string

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

func (*PathFlag) TakesValue ¶

func (f *PathFlag) TakesValue() bool

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

type RequiredFlag ¶

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 RequiredFlag interface {
    Flag

    IsRequired() bool
}

type Serializer ¶

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

type Serializer interface {
    Serialize() string
}

type SliceFlag ¶

SliceFlag extends implementations like StringSliceFlag and IntSliceFlag with support for using slices directly, as Value and/or Destination. See also SliceFlagTarget, MultiStringFlag, MultiFloat64Flag, MultiInt64Flag, MultiIntFlag.

type SliceFlag[T SliceFlagTarget[E], S ~[]E, E any] struct {
    Target      T
    Value       S
    Destination *S
}

func (*SliceFlag[T, S, E]) Apply ¶

func (x *SliceFlag[T, S, E]) Apply(set *flag.FlagSet) error

func (*SliceFlag[T, S, E]) GetCategory ¶

func (x *SliceFlag[T, S, E]) GetCategory() string

func (*SliceFlag[T, S, E]) GetDefaultText ¶

func (x *SliceFlag[T, S, E]) GetDefaultText() string

func (*SliceFlag[T, S, E]) GetDestination ¶

func (x *SliceFlag[T, S, E]) GetDestination() S

func (*SliceFlag[T, S, E]) GetEnvVars ¶

func (x *SliceFlag[T, S, E]) GetEnvVars() []string

func (*SliceFlag[T, S, E]) GetUsage ¶

func (x *SliceFlag[T, S, E]) GetUsage() string

func (*SliceFlag[T, S, E]) GetValue ¶

func (x *SliceFlag[T, S, E]) GetValue() string

func (*SliceFlag[T, S, E]) IsRequired ¶

func (x *SliceFlag[T, S, E]) IsRequired() bool

func (*SliceFlag[T, S, E]) IsSet ¶

func (x *SliceFlag[T, S, E]) IsSet() bool

func (*SliceFlag[T, S, E]) IsVisible ¶

func (x *SliceFlag[T, S, E]) IsVisible() bool

func (*SliceFlag[T, S, E]) Names ¶

func (x *SliceFlag[T, S, E]) Names() []string

func (*SliceFlag[T, S, E]) SetDestination ¶

func (x *SliceFlag[T, S, E]) SetDestination(slice S)

func (*SliceFlag[T, S, E]) SetValue ¶

func (x *SliceFlag[T, S, E]) SetValue(slice S)

func (*SliceFlag[T, S, E]) String ¶

func (x *SliceFlag[T, S, E]) String() string

func (*SliceFlag[T, S, E]) TakesValue ¶

func (x *SliceFlag[T, S, E]) TakesValue() bool

type SliceFlagTarget ¶

SliceFlagTarget models a target implementation for use with SliceFlag. The three methods, SetValue, SetDestination, and GetDestination, are necessary to propagate Value and Destination, where Value is propagated inwards (initially), and Destination is propagated outwards (on every update).

type SliceFlagTarget[E any] interface {
    Flag
    RequiredFlag
    DocGenerationFlag
    VisibleFlag
    CategorizableFlag

    // SetValue should propagate the given slice to the target, ideally as a new value.
    // Note that a nil slice should nil/clear any existing value (modelled as ~[]E).
    SetValue(slice []E)
    // SetDestination should propagate the given slice to the target, ideally as a new value.
    // Note that a nil slice should nil/clear any existing value (modelled as ~*[]E).
    SetDestination(slice []E)
    // GetDestination should return the current value referenced by any destination, or nil if nil/unset.
    GetDestination() []E
}

type StringFlag ¶

StringFlag is a flag with type string

type StringFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       string
    Destination *string

    Aliases []string
    EnvVars []string

    TakesFile bool

    Action func(*Context, string) error
    // contains filtered or unexported fields
}

func (*StringFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*StringFlag) Get ¶

func (f *StringFlag) Get(ctx *Context) string

Get returns the flag’s value in the given Context.

func (*StringFlag) GetCategory ¶

func (f *StringFlag) GetCategory() string

GetCategory returns the category for the flag

func (*StringFlag) GetDefaultText ¶

func (f *StringFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*StringFlag) GetEnvVars ¶

func (f *StringFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *StringFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*StringFlag) IsVisible ¶

func (f *StringFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*StringFlag) Names ¶

func (f *StringFlag) Names() []string

Names returns the names of the flag

func (*StringFlag) RunAction ¶

func (f *StringFlag) RunAction(c *Context) error

RunAction executes flag action if set

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 ¶

StringSlice wraps a []string to satisfy flag.Value

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

func NewStringSlice ¶

func NewStringSlice(defaults ...string) *StringSlice

NewStringSlice creates a *StringSlice with default values

func (*StringSlice) Get ¶

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

Get returns the slice of strings set by this flag

func (*StringSlice) Serialize ¶

func (s *StringSlice) Serialize() string

Serialize allows StringSlice to fulfill Serializer

func (*StringSlice) Set ¶

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

Set appends the string value to the list of values

func (*StringSlice) String ¶

func (s *StringSlice) String() string

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

func (*StringSlice) Value ¶

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

Value returns the slice of strings set by this flag

func (*StringSlice) WithSeparatorSpec ¶

func (s *StringSlice) WithSeparatorSpec(spec separatorSpec)

type StringSliceFlag ¶

StringSliceFlag is a flag with type *StringSlice

type StringSliceFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       *StringSlice
    Destination *StringSlice

    Aliases []string
    EnvVars []string

    TakesFile bool

    Action func(*Context, []string) error

    KeepSpace bool
    // contains filtered or unexported fields
}

func (*StringSliceFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*StringSliceFlag) Get ¶

func (f *StringSliceFlag) Get(ctx *Context) []string

Get returns the flag’s value in the given Context.

func (*StringSliceFlag) GetCategory ¶

func (f *StringSliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*StringSliceFlag) GetDefaultText ¶

func (f *StringSliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*StringSliceFlag) GetDestination ¶

func (f *StringSliceFlag) GetDestination() []string

func (*StringSliceFlag) GetEnvVars ¶

func (f *StringSliceFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *StringSliceFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*StringSliceFlag) IsSliceFlag ¶

func (f *StringSliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*StringSliceFlag) IsVisible ¶

func (f *StringSliceFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*StringSliceFlag) Names ¶

func (f *StringSliceFlag) Names() []string

Names returns the names of the flag

func (*StringSliceFlag) RunAction ¶

func (f *StringSliceFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*StringSliceFlag) SetDestination ¶

func (f *StringSliceFlag) SetDestination(slice []string)

func (*StringSliceFlag) SetValue ¶

func (f *StringSliceFlag) SetValue(slice []string)

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

func (*StringSliceFlag) WithSeparatorSpec ¶

func (f *StringSliceFlag) WithSeparatorSpec(spec separatorSpec)

type SuggestCommandFunc ¶

type SuggestCommandFunc func(commands []*Command, provided string) string

type SuggestFlagFunc ¶

type SuggestFlagFunc func(flags []Flag, provided string, hideHelp bool) string

type Timestamp ¶

Timestamp wrap to satisfy golang's flag interface.

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

func NewTimestamp ¶

func NewTimestamp(timestamp time.Time) *Timestamp

Timestamp constructor

func (*Timestamp) Get ¶

func (t *Timestamp) Get() interface{}

Get returns the flag structure

func (*Timestamp) Set ¶

func (t *Timestamp) Set(value string) error

Parses the string value to timestamp

func (*Timestamp) SetLayout ¶

func (t *Timestamp) SetLayout(layout string)

Set the timestamp string layout for future parsing

func (*Timestamp) SetLocation ¶

func (t *Timestamp) SetLocation(loc *time.Location)

Set perceived timezone of the to-be parsed time string

func (*Timestamp) SetTimestamp ¶

func (t *Timestamp) SetTimestamp(value time.Time)

Set the timestamp value directly

func (*Timestamp) String ¶

func (t *Timestamp) String() string

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

func (*Timestamp) Value ¶

func (t *Timestamp) Value() *time.Time

Value returns the timestamp value stored in the flag

type TimestampFlag ¶

TimestampFlag is a flag with type *Timestamp

type TimestampFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       *Timestamp
    Destination *Timestamp

    Aliases []string
    EnvVars []string

    Layout string

    Timezone *time.Location

    Action func(*Context, *time.Time) error
    // contains filtered or unexported fields
}

func (*TimestampFlag) Apply ¶

func (f *TimestampFlag) Apply(set *flag.FlagSet) error

Apply populates the flag given the flag set and environment

func (*TimestampFlag) Get ¶

func (f *TimestampFlag) Get(ctx *Context) *time.Time

Get returns the flag’s value in the given Context.

func (*TimestampFlag) GetCategory ¶

func (f *TimestampFlag) GetCategory() string

GetCategory returns the category for the flag

func (*TimestampFlag) GetDefaultText ¶

func (f *TimestampFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*TimestampFlag) GetEnvVars ¶

func (f *TimestampFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this flag

func (*TimestampFlag) GetUsage ¶

func (f *TimestampFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*TimestampFlag) GetValue ¶

func (f *TimestampFlag) GetValue() string

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

func (*TimestampFlag) IsRequired ¶

func (f *TimestampFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*TimestampFlag) IsSet ¶

func (f *TimestampFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*TimestampFlag) IsVisible ¶

func (f *TimestampFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*TimestampFlag) Names ¶

func (f *TimestampFlag) Names() []string

Names returns the names of the flag

func (*TimestampFlag) RunAction ¶

func (f *TimestampFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*TimestampFlag) String ¶

func (f *TimestampFlag) String() string

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

func (*TimestampFlag) TakesValue ¶

func (f *TimestampFlag) TakesValue() bool

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

type Uint64Flag ¶

Uint64Flag is a flag with type uint64

type Uint64Flag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       uint64
    Destination *uint64

    Aliases []string
    EnvVars []string

    Base int

    Action func(*Context, uint64) error
    // contains filtered or unexported fields
}

func (*Uint64Flag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*Uint64Flag) Get ¶

func (f *Uint64Flag) Get(ctx *Context) uint64

Get returns the flag’s value in the given Context.

func (*Uint64Flag) GetCategory ¶

func (f *Uint64Flag) GetCategory() string

GetCategory returns the category for the flag

func (*Uint64Flag) GetDefaultText ¶

func (f *Uint64Flag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Uint64Flag) GetEnvVars ¶

func (f *Uint64Flag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *Uint64Flag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*Uint64Flag) IsVisible ¶

func (f *Uint64Flag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*Uint64Flag) Names ¶

func (f *Uint64Flag) Names() []string

Names returns the names of the flag

func (*Uint64Flag) RunAction ¶

func (f *Uint64Flag) RunAction(c *Context) error

RunAction executes flag action if set

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 Uint64Slice ¶

Uint64Slice wraps []int64 to satisfy flag.Value

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

func NewUint64Slice ¶

func NewUint64Slice(defaults ...uint64) *Uint64Slice

NewUint64Slice makes an *Uint64Slice with default values

func (*Uint64Slice) Get ¶

func (i *Uint64Slice) Get() interface{}

Get returns the slice of ints set by this flag

func (*Uint64Slice) Serialize ¶

func (i *Uint64Slice) Serialize() string

Serialize allows Uint64Slice to fulfill Serializer

func (*Uint64Slice) Set ¶

func (i *Uint64Slice) Set(value string) error

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

func (*Uint64Slice) String ¶

func (i *Uint64Slice) String() string

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

func (*Uint64Slice) Value ¶

func (i *Uint64Slice) Value() []uint64

Value returns the slice of ints set by this flag

func (*Uint64Slice) WithSeparatorSpec ¶

func (i *Uint64Slice) WithSeparatorSpec(spec separatorSpec)

type Uint64SliceFlag ¶

Uint64SliceFlag is a flag with type *Uint64Slice

type Uint64SliceFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       *Uint64Slice
    Destination *Uint64Slice

    Aliases []string
    EnvVars []string

    Action func(*Context, []uint64) error
    // contains filtered or unexported fields
}

func (*Uint64SliceFlag) Apply ¶

func (f *Uint64SliceFlag) Apply(set *flag.FlagSet) error

Apply populates the flag given the flag set and environment

func (*Uint64SliceFlag) Get ¶

func (f *Uint64SliceFlag) Get(ctx *Context) []uint64

Get returns the flag’s value in the given Context.

func (*Uint64SliceFlag) GetCategory ¶

func (f *Uint64SliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*Uint64SliceFlag) GetDefaultText ¶

func (f *Uint64SliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Uint64SliceFlag) GetEnvVars ¶

func (f *Uint64SliceFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this flag

func (*Uint64SliceFlag) GetUsage ¶

func (f *Uint64SliceFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*Uint64SliceFlag) GetValue ¶

func (f *Uint64SliceFlag) GetValue() string

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

func (*Uint64SliceFlag) IsRequired ¶

func (f *Uint64SliceFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*Uint64SliceFlag) IsSet ¶

func (f *Uint64SliceFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*Uint64SliceFlag) IsSliceFlag ¶

func (f *Uint64SliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*Uint64SliceFlag) IsVisible ¶

func (f *Uint64SliceFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*Uint64SliceFlag) Names ¶

func (f *Uint64SliceFlag) Names() []string

Names returns the names of the flag

func (*Uint64SliceFlag) RunAction ¶

func (f *Uint64SliceFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*Uint64SliceFlag) String ¶

func (f *Uint64SliceFlag) String() string

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

func (*Uint64SliceFlag) TakesValue ¶

func (f *Uint64SliceFlag) TakesValue() bool

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

func (*Uint64SliceFlag) WithSeparatorSpec ¶

func (f *Uint64SliceFlag) WithSeparatorSpec(spec separatorSpec)

type UintFlag ¶

UintFlag is a flag with type uint

type UintFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       uint
    Destination *uint

    Aliases []string
    EnvVars []string

    Base int

    Action func(*Context, uint) error
    // contains filtered or unexported fields
}

func (*UintFlag) Apply ¶

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

Apply populates the flag given the flag set and environment

func (*UintFlag) Get ¶

func (f *UintFlag) Get(ctx *Context) uint

Get returns the flag’s value in the given Context.

func (*UintFlag) GetCategory ¶

func (f *UintFlag) GetCategory() string

GetCategory returns the category for the flag

func (*UintFlag) GetDefaultText ¶

func (f *UintFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*UintFlag) GetEnvVars ¶

func (f *UintFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this 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) IsSet ¶

func (f *UintFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*UintFlag) IsVisible ¶

func (f *UintFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*UintFlag) Names ¶

func (f *UintFlag) Names() []string

Names returns the names of the flag

func (*UintFlag) RunAction ¶

func (f *UintFlag) RunAction(c *Context) error

RunAction executes flag action if set

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

type UintSlice ¶

UintSlice wraps []int to satisfy flag.Value

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

func NewUintSlice ¶

func NewUintSlice(defaults ...uint) *UintSlice

NewUintSlice makes an *UintSlice with default values

func (*UintSlice) Get ¶

func (i *UintSlice) Get() interface{}

Get returns the slice of ints set by this flag

func (*UintSlice) Serialize ¶

func (i *UintSlice) Serialize() string

Serialize allows UintSlice to fulfill Serializer

func (*UintSlice) Set ¶

func (i *UintSlice) Set(value string) error

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

func (*UintSlice) SetUint ¶

func (i *UintSlice) SetUint(value uint)

TODO: Consistently have specific Set function for Int64 and Float64 ? SetInt directly adds an integer to the list of values

func (*UintSlice) String ¶

func (i *UintSlice) String() string

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

func (*UintSlice) Value ¶

func (i *UintSlice) Value() []uint

Value returns the slice of ints set by this flag

func (*UintSlice) WithSeparatorSpec ¶

func (i *UintSlice) WithSeparatorSpec(spec separatorSpec)

type UintSliceFlag ¶

UintSliceFlag is a flag with type *UintSlice

type UintSliceFlag struct {
    Name string

    Category    string
    DefaultText string
    FilePath    string
    Usage       string

    Required   bool
    Hidden     bool
    HasBeenSet bool

    Value       *UintSlice
    Destination *UintSlice

    Aliases []string
    EnvVars []string

    Action func(*Context, []uint) error
    // contains filtered or unexported fields
}

func (*UintSliceFlag) Apply ¶

func (f *UintSliceFlag) Apply(set *flag.FlagSet) error

Apply populates the flag given the flag set and environment

func (*UintSliceFlag) Get ¶

func (f *UintSliceFlag) Get(ctx *Context) []uint

Get returns the flag’s value in the given Context.

func (*UintSliceFlag) GetCategory ¶

func (f *UintSliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*UintSliceFlag) GetDefaultText ¶

func (f *UintSliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*UintSliceFlag) GetEnvVars ¶

func (f *UintSliceFlag) GetEnvVars() []string

GetEnvVars returns the env vars for this flag

func (*UintSliceFlag) GetUsage ¶

func (f *UintSliceFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*UintSliceFlag) GetValue ¶

func (f *UintSliceFlag) GetValue() string

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

func (*UintSliceFlag) IsRequired ¶

func (f *UintSliceFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*UintSliceFlag) IsSet ¶

func (f *UintSliceFlag) IsSet() bool

IsSet returns whether or not the flag has been set through env or file

func (*UintSliceFlag) IsSliceFlag ¶

func (f *UintSliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*UintSliceFlag) IsVisible ¶

func (f *UintSliceFlag) IsVisible() bool

IsVisible returns true if the flag is not hidden, otherwise false

func (*UintSliceFlag) Names ¶

func (f *UintSliceFlag) Names() []string

Names returns the names of the flag

func (*UintSliceFlag) RunAction ¶

func (f *UintSliceFlag) RunAction(c *Context) error

RunAction executes flag action if set

func (*UintSliceFlag) String ¶

func (f *UintSliceFlag) String() string

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

func (*UintSliceFlag) TakesValue ¶

func (f *UintSliceFlag) TakesValue() bool

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

func (*UintSliceFlag) WithSeparatorSpec ¶

func (f *UintSliceFlag) WithSeparatorSpec(spec separatorSpec)

type VisibleFlag ¶

VisibleFlag is an interface that allows to check if a flag is visible

type VisibleFlag interface {
    Flag

    // IsVisible returns true if the flag is not hidden, otherwise false
    IsVisible() bool
}

type VisibleFlagCategory ¶

VisibleFlagCategory is a category containing flags.

type VisibleFlagCategory interface {
    // Name returns the category name string
    Name() string
    // Flags returns a slice of VisibleFlag sorted by name
    Flags() []VisibleFlag
}

Subdirectories