cli

package module
v2.27.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2024 License: MIT Imports: 23 Imported by: 17,405

README

cli

Run Tests Go Reference Go Report Card codecov

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

Documentation

More documentation is available in ./docs or the hosted documentation site at https://cli.urfave.org.

License

See LICENSE

Documentation

Overview

Package cli provides a minimal framework for creating and organizing command line Go applications. cli is designed to be easy to understand and write, the most simple cli application can be written as follows: 

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

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

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

	app.Run(os.Args)
}

Index

Examples

Constants

This section is empty.

Variables

View Source 
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
)
View Source 
var AppHelpTemplate = `` /* 859-byte string literal not displayed */

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

View Source 
var CommandHelpTemplate = `` /* 377-byte string literal not displayed */

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

View Source 
var ErrWriter io.Writer = os.Stderr

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

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

HelpPrinter is a function that writes the help output. If not set explicitly, this calls HelpPrinterCustom using only the default template functions.

If custom logic for printing help is required, this function can be overridden. If the ExtraInfo field is defined on an App, this function should not be modified, as HelpPrinterCustom will be used directly in order to capture the extra information.

View Source 
var HelpPrinterCustom helpPrinterCustom = printHelpCustom

HelpPrinterCustom is a function that writes the help output. It is used as the default implementation of HelpPrinter, and may be called directly if the ExtraInfo field is set on an App.

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.

View Source 
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 }}`
View Source 
var OsExiter = os.Exit

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

View Source 
var SubcommandHelpTemplate = `` /* 584-byte string literal not displayed */

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

View Source 
var VersionPrinter = printVersion

VersionPrinter prints the version for the App

Functions

func DefaultAppComplete 

func DefaultAppComplete(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 added in v2.7.0 

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 added in v2.3.0 

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

Types

type ActionFunc 

type ActionFunc func(*Context) error

ActionFunc is the action to execute when no subcommands are specified

type ActionableFlag added in v2.17.0 

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

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

type AfterFunc 

type AfterFunc func(*Context) error

AfterFunc is an action to execute after any subcommands are run, but after the subcommand has finished it is run even if Action() panics

type App 

type App struct {
	// The name of the program. Defaults to path.Base(os.Args[0])
	Name string
	// Full name of command for help, defaults to Name
	HelpName string
	// Description of the program.
	Usage string
	// Text to override the USAGE section of help
	UsageText string
	// 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
}

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

func NewApp 

func NewApp() *App

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

func (*App) Command 

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

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

func (*App) Run 

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

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

Example 
// 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
}

Output:

Hello Jeremy
Example (AppHelp) 
// 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)

Output:

NAME:
   greet - A new cli application

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

VERSION:
   0.1.0

DESCRIPTION:
   This is how we describe greet the app

AUTHORS:
   Harrison <harrison@lolwut.com>
   Oliver Allen <oliver@toyshop.com>

COMMANDS:
   describeit, d  use it to see a description
   help, h        Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --name value   a name to say (default: "bob")
   --help, -h     show help
   --version, -v  print the version
Example (BashComplete) 
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)

Output:

describeit
d
next
help
h
Example (BashComplete_withLongFlag) 
os.Setenv("SHELL", "bash")
os.Args = []string{"greet", "--s", "--generate-bash-completion"}

app := NewApp()
app.Name = "greet"
app.EnableBashCompletion = true
app.Flags = []Flag{
	&IntFlag{
		Name:    "other",
		Aliases: []string{"o"},
	},
	&StringFlag{
		Name:    "xyz",
		Aliases: []string{"x"},
	},
	&StringFlag{
		Name: "some-flag,s",
	},
	&StringFlag{
		Name: "similar-flag",
	},
}

_ = app.Run(os.Args)

Output:

--some-flag
--similar-flag
Example (BashComplete_withMultipleLongFlag) 
os.Setenv("SHELL", "bash")
os.Args = []string{"greet", "--st", "--generate-bash-completion"}

app := NewApp()
app.Name = "greet"
app.EnableBashCompletion = true
app.Flags = []Flag{
	&IntFlag{
		Name:    "int-flag",
		Aliases: []string{"i"},
	},
	&StringFlag{
		Name:    "string",
		Aliases: []string{"s"},
	},
	&StringFlag{
		Name: "string-flag-2",
	},
	&StringFlag{
		Name: "similar-flag",
	},
	&StringFlag{
		Name: "some-flag",
	},
}

_ = app.Run(os.Args)

Output:

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

app := NewApp()
app.Name = "greet"
app.EnableBashCompletion = true
app.Flags = []Flag{
	&IntFlag{
		Name:    "other",
		Aliases: []string{"o"},
	},
	&StringFlag{
		Name:    "xyz",
		Aliases: []string{"x"},
	},
}

_ = app.Run(os.Args)

Output:

--other
-o
--xyz
-x
--help
-h
Example (CommandHelp) 
// 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",
			Args:        true,
			Action: func(c *Context) error {
				fmt.Printf("i like to describe things")
				return nil
			},
		},
	},
}
_ = app.Run(os.Args)

Output:

NAME:
   greet describeit - use it to see a description

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

DESCRIPTION:
   This is how we describe describeit the function

OPTIONS:
   --help, -h  show help
Example (NoAction) 
app := App{}
app.Name = "greet"
app.Args = true
_ = app.Run([]string{"greet"})

Output:

NAME:
   greet - A new cli application

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

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

GLOBAL OPTIONS:
   --help, -h  show help
Example (SliceValues) 
// 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)

Output:

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

_ = app.Run(os.Args)

Output:

Hello, Jeremy
Example (SubcommandNoAction) 
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"})

Output:

NAME:
   greet describeit - use it to see a description

USAGE:
   greet describeit [command options]

DESCRIPTION:
   This is how we describe describeit the function

OPTIONS:
   --help, -h  show help
Example (ZshComplete) 
// 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)

Output:

describeit:use it to see a description
d:use it to see a description
next:next example
help:Shows a list of commands or help for one command
h:Shows a list of commands or help for one command

func (*App) RunAndExitOnError deprecated 

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 added in v2.1.0 

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 added in v2.4.0 

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 added in v2.8.0 

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 

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

Author represents someone who has contributed to a cli project.

func (*Author) String 

func (a *Author) String() string

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

type BashCompleteFunc 

type BashCompleteFunc func(*Context)

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

type BeforeFunc 

type BeforeFunc func(*Context) error

BeforeFunc is an action to execute before any subcommands are run, but after the context is ready if a non-nil error is returned, no subcommands are run

type BoolFlag 

type BoolFlag struct {
	Name string

	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
}

BoolFlag is a flag with type bool

func (*BoolFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*BoolFlag) Get added in v2.6.0 

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

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

func (*BoolFlag) GetCategory added in v2.8.0 

func (f *BoolFlag) GetCategory() string

GetCategory returns the category for the flag

func (*BoolFlag) GetDefaultText added in v2.4.4 

func (f *BoolFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*BoolFlag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 added in v2.8.0 

type CategorizableFlag interface {
	VisibleFlag

	GetCategory() string
}

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

type Command 

type Command struct {
	// The name of the command
	Name string
	// A list of aliases for the command
	Aliases []string
	// A short description of the usage of this command
	Usage string
	// Custom text to show on USAGE section of help
	UsageText string
	// A longer explanation of how the command works
	Description string
	// 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
}

Command is a subcommand for a cli.App.

func (*Command) Command added in v2.20.0 

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 added in v2.20.0 

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

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

func (*Command) VisibleCommands added in v2.19.0 

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

VisibleCommands returns a slice of the Commands with Hidden=false

func (*Command) VisibleFlagCategories added in v2.8.0 

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 

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
}

CommandCategories interface allows for category manipulation

type CommandCategory 

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

CommandCategory is a category containing commands.

type CommandNotFoundFunc 

type CommandNotFoundFunc func(*Context, string)

CommandNotFoundFunc is executed if the proper command cannot be found

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 

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

Context is a type that is passed through to each Handler action in a cli application. Context can be used to retrieve context-specific args and parsed command-line options.

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 added in v2.15.0 

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 added in v2.1.0 

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 added in v2.16.0 

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

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

func (*Context) UintSlice added in v2.16.0 

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

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

func (*Context) Value added in v2.1.0 

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

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

type Countable added in v2.15.0 

type Countable interface {
	Count() int
}

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

type DocGenerationFlag 

type DocGenerationFlag interface {
	Flag

	// TakesValue returns true if the flag takes a value, otherwise false
	TakesValue() bool

	// GetUsage returns the usage string for the flag
	GetUsage() string

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

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

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

DocGenerationFlag is an interface that allows documentation generation for the flag

type DocGenerationSliceFlag added in v2.18.0 

type DocGenerationSliceFlag interface {
	DocGenerationFlag

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

DocGenerationSliceFlag extends DocGenerationFlag for slice-based flags.

type DurationFlag 

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
}

DurationFlag is a flag with type time.Duration

func (*DurationFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*DurationFlag) Get added in v2.6.0 

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

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

func (*DurationFlag) GetCategory added in v2.8.0 

func (f *DurationFlag) GetCategory() string

GetCategory returns the category for the flag

func (*DurationFlag) GetDefaultText added in v2.4.4 

func (f *DurationFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*DurationFlag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 

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

ErrorFormatter is the interface that will suitably format the error output

type ExitCoder 

type ExitCoder interface {
	error
	ExitCode() int
}

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

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 deprecated 

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 

type ExitErrHandlerFunc func(cCtx *Context, err error)

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

type Flag 

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

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

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

BashCompletionFlag enables bash-completion for all commands and subcommands 

var HelpFlag Flag = &BoolFlag{
	Name:               "help",
	Aliases:            []string{"h"},
	Usage:              "show help",
	DisableDefaultText: 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 VersionFlag Flag = &BoolFlag{
	Name:               "version",
	Aliases:            []string{"v"},
	Usage:              "print the version",
	DisableDefaultText: true,
}

VersionFlag prints the version for the application

type FlagCategories added in v2.8.0 

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
}

FlagCategories interface allows for category manipulation

type FlagEnvHintFunc 

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

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

var FlagEnvHinter FlagEnvHintFunc = withEnvHint

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

type FlagFileHintFunc 

type FlagFileHintFunc func(filePath, str string) string

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

var FlagFileHinter FlagFileHintFunc = withFileHint

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

type FlagNamePrefixFunc 

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

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

var FlagNamePrefixer FlagNamePrefixFunc = prefixedNames

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

type FlagStringFunc 

type FlagStringFunc func(Flag) string

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

var FlagStringer FlagStringFunc = stringifyFlag

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

type FlagsByName 

type FlagsByName []Flag

FlagsByName is a slice of Flag.

func (FlagsByName) Len 

func (f FlagsByName) Len() int

func (FlagsByName) Less 

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

func (FlagsByName) Swap 

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

type Float64Flag 

type Float64Flag struct {
	Name string

	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
}

Float64Flag is a flag with type float64

func (*Float64Flag) Apply 

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

Apply populates the flag given the flag set and environment

func (*Float64Flag) Get added in v2.6.0 

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

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

func (*Float64Flag) GetCategory added in v2.8.0 

func (f *Float64Flag) GetCategory() string

GetCategory returns the category for the flag

func (*Float64Flag) GetDefaultText added in v2.4.4 

func (f *Float64Flag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Float64Flag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 

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

Float64Slice wraps []float64 to satisfy flag.Value

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 added in v2.24.2 

func (f *Float64Slice) WithSeparatorSpec(spec separatorSpec)

type Float64SliceFlag 

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
}

Float64SliceFlag is a flag with type *Float64Slice

func (*Float64SliceFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*Float64SliceFlag) Get added in v2.6.0 

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

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

func (*Float64SliceFlag) GetCategory added in v2.8.0 

func (f *Float64SliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*Float64SliceFlag) GetDefaultText added in v2.4.4 

func (f *Float64SliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Float64SliceFlag) GetDestination added in v2.9.0 

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

func (*Float64SliceFlag) GetEnvVars added in v2.4.4 

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 added in v2.18.0 

func (f *Float64SliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*Float64SliceFlag) IsVisible added in v2.4.0 

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 added in v2.17.0 

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

RunAction executes flag action if set

func (*Float64SliceFlag) SetDestination added in v2.9.0 

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

func (*Float64SliceFlag) SetValue added in v2.9.0 

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 added in v2.24.2 

func (f *Float64SliceFlag) WithSeparatorSpec(spec separatorSpec)

type Generic 

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

Generic is a generic parseable type identified by a specific flag

type GenericFlag 

type GenericFlag struct {
	Name string

	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
}

GenericFlag is a flag with type Generic

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 added in v2.6.0 

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

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

func (*GenericFlag) GetCategory added in v2.8.0 

func (f *GenericFlag) GetCategory() string

GetCategory returns the category for the flag

func (*GenericFlag) GetDefaultText added in v2.4.4 

func (f *GenericFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*GenericFlag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 

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
}

Int64Flag is a flag with type int64

func (*Int64Flag) Apply 

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

Apply populates the flag given the flag set and environment

func (*Int64Flag) Get added in v2.6.0 

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

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

func (*Int64Flag) GetCategory added in v2.8.0 

func (f *Int64Flag) GetCategory() string

GetCategory returns the category for the flag

func (*Int64Flag) GetDefaultText added in v2.4.4 

func (f *Int64Flag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Int64Flag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 

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

Int64Slice wraps []int64 to satisfy flag.Value

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 added in v2.24.2 

func (i *Int64Slice) WithSeparatorSpec(spec separatorSpec)

type Int64SliceFlag 

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
}

Int64SliceFlag is a flag with type *Int64Slice

func (*Int64SliceFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*Int64SliceFlag) Get added in v2.6.0 

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

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

func (*Int64SliceFlag) GetCategory added in v2.8.0 

func (f *Int64SliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*Int64SliceFlag) GetDefaultText added in v2.4.4 

func (f *Int64SliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Int64SliceFlag) GetDestination added in v2.9.0 

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

func (*Int64SliceFlag) GetEnvVars added in v2.4.4 

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 added in v2.18.0 

func (f *Int64SliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*Int64SliceFlag) IsVisible added in v2.4.0 

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 added in v2.17.0 

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

RunAction executes flag action if set

func (*Int64SliceFlag) SetDestination added in v2.9.0 

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

func (*Int64SliceFlag) SetValue added in v2.9.0 

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 added in v2.24.2 

func (f *Int64SliceFlag) WithSeparatorSpec(spec separatorSpec)

type IntFlag 

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
}

IntFlag is a flag with type int

func (*IntFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*IntFlag) Get added in v2.6.0 

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

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

func (*IntFlag) GetCategory added in v2.8.0 

func (f *IntFlag) GetCategory() string

GetCategory returns the category for the flag

func (*IntFlag) GetDefaultText added in v2.4.4 

func (f *IntFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*IntFlag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 

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

IntSlice wraps []int to satisfy flag.Value

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 added in v2.24.2 

func (i *IntSlice) WithSeparatorSpec(spec separatorSpec)

type IntSliceFlag 

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
}

IntSliceFlag is a flag with type *IntSlice

func (*IntSliceFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*IntSliceFlag) Get added in v2.6.0 

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

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

func (*IntSliceFlag) GetCategory added in v2.8.0 

func (f *IntSliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*IntSliceFlag) GetDefaultText added in v2.4.4 

func (f *IntSliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*IntSliceFlag) GetDestination added in v2.9.0 

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

func (*IntSliceFlag) GetEnvVars added in v2.4.4 

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 added in v2.18.0 

func (f *IntSliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*IntSliceFlag) IsVisible added in v2.4.0 

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 added in v2.17.0 

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

RunAction executes flag action if set

func (*IntSliceFlag) SetDestination added in v2.9.0 

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

func (*IntSliceFlag) SetValue added in v2.9.0 

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 added in v2.24.2 

func (f *IntSliceFlag) WithSeparatorSpec(spec separatorSpec)

type InvalidFlagAccessFunc added in v2.14.0 

type InvalidFlagAccessFunc func(*Context, string)

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

type MultiError 

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

MultiError is an error that wraps multiple errors.

type MultiFloat64Flag added in v2.9.0 

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

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

type MultiInt64Flag added in v2.9.0 

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

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

type MultiIntFlag added in v2.9.0 

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

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

type MultiStringFlag added in v2.9.0 

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

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

Example 
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...)
}()

Output:

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 

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

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 Path added in v2.7.0 

type Path = string

type PathFlag 

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
}

PathFlag is a flag with type Path

func (*PathFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*PathFlag) Get added in v2.6.0 

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

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

func (*PathFlag) GetCategory added in v2.8.0 

func (f *PathFlag) GetCategory() string

GetCategory returns the category for the flag

func (*PathFlag) GetDefaultText added in v2.4.4 

func (f *PathFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*PathFlag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 

type RequiredFlag interface {
	Flag

	IsRequired() bool
}

RequiredFlag is an interface that allows us to mark flags as required it allows flags required flags to be backwards compatible with the Flag interface

type Serializer 

type Serializer interface {
	Serialize() string
}

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

type SliceFlag added in v2.9.0 

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

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.

func (*SliceFlag[T, S, E]) Apply added in v2.9.0 

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

func (*SliceFlag[T, S, E]) GetCategory added in v2.9.0 

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

func (*SliceFlag[T, S, E]) GetDefaultText added in v2.9.0 

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

func (*SliceFlag[T, S, E]) GetDestination added in v2.9.0 

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

func (*SliceFlag[T, S, E]) GetEnvVars added in v2.9.0 

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

func (*SliceFlag[T, S, E]) GetUsage added in v2.9.0 

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

func (*SliceFlag[T, S, E]) GetValue added in v2.9.0 

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

func (*SliceFlag[T, S, E]) IsRequired added in v2.9.0 

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

func (*SliceFlag[T, S, E]) IsSet added in v2.9.0 

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

func (*SliceFlag[T, S, E]) IsVisible added in v2.9.0 

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

func (*SliceFlag[T, S, E]) Names added in v2.9.0 

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

func (*SliceFlag[T, S, E]) SetDestination added in v2.9.0 

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

func (*SliceFlag[T, S, E]) SetValue added in v2.9.0 

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

func (*SliceFlag[T, S, E]) String added in v2.9.0 

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

func (*SliceFlag[T, S, E]) TakesValue added in v2.9.0 

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

type SliceFlagTarget added in v2.9.0 

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
}

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 StringFlag 

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
}

StringFlag is a flag with type string

func (*StringFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*StringFlag) Get added in v2.6.0 

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

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

func (*StringFlag) GetCategory added in v2.8.0 

func (f *StringFlag) GetCategory() string

GetCategory returns the category for the flag

func (*StringFlag) GetDefaultText added in v2.4.4 

func (f *StringFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*StringFlag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 

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

StringSlice wraps a []string to satisfy flag.Value

func NewStringSlice 

func NewStringSlice(defaults ...string) *StringSlice

NewStringSlice creates a *StringSlice with default values

func (*StringSlice) 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 added in v2.24.2 

func (s *StringSlice) WithSeparatorSpec(spec separatorSpec)

type StringSliceFlag 

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
}

StringSliceFlag is a flag with type *StringSlice

func (*StringSliceFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*StringSliceFlag) Get added in v2.6.0 

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

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

func (*StringSliceFlag) GetCategory added in v2.8.0 

func (f *StringSliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*StringSliceFlag) GetDefaultText added in v2.4.4 

func (f *StringSliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*StringSliceFlag) GetDestination added in v2.9.0 

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

func (*StringSliceFlag) GetEnvVars added in v2.4.4 

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 added in v2.18.0 

func (f *StringSliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*StringSliceFlag) IsVisible added in v2.4.0 

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 added in v2.17.0 

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

RunAction executes flag action if set

func (*StringSliceFlag) SetDestination added in v2.9.0 

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

func (*StringSliceFlag) SetValue added in v2.9.0 

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 added in v2.24.2 

func (f *StringSliceFlag) WithSeparatorSpec(spec separatorSpec)

type SuggestCommandFunc added in v2.8.0 

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

type SuggestFlagFunc added in v2.8.0 

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

type Timestamp added in v2.1.0 

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

Timestamp wrap to satisfy golang's flag interface.

func NewTimestamp added in v2.1.0 

func NewTimestamp(timestamp time.Time) *Timestamp

Timestamp constructor

func (*Timestamp) Get added in v2.1.0 

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

Get returns the flag structure

func (*Timestamp) Set added in v2.1.0 

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

Parses the string value to timestamp

func (*Timestamp) SetLayout added in v2.1.0 

func (t *Timestamp) SetLayout(layout string)

Set the timestamp string layout for future parsing

func (*Timestamp) SetLocation added in v2.11.0 

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

Set perceived timezone of the to-be parsed time string

func (*Timestamp) SetTimestamp added in v2.1.0 

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

Set the timestamp value directly

func (*Timestamp) String added in v2.1.0 

func (t *Timestamp) String() string

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

func (*Timestamp) Value added in v2.1.0 

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

Value returns the timestamp value stored in the flag

type TimestampFlag added in v2.1.0 

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
}

TimestampFlag is a flag with type *Timestamp

func (*TimestampFlag) Apply added in v2.1.0 

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

Apply populates the flag given the flag set and environment

func (*TimestampFlag) Get added in v2.6.0 

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

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

func (*TimestampFlag) GetCategory added in v2.8.0 

func (f *TimestampFlag) GetCategory() string

GetCategory returns the category for the flag

func (*TimestampFlag) GetDefaultText added in v2.4.4 

func (f *TimestampFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*TimestampFlag) GetEnvVars added in v2.4.4 

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

GetEnvVars returns the env vars for this flag

func (*TimestampFlag) GetUsage added in v2.1.0 

func (f *TimestampFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*TimestampFlag) GetValue added in v2.1.0 

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 added in v2.1.0 

func (f *TimestampFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*TimestampFlag) IsSet added in v2.1.0 

func (f *TimestampFlag) IsSet() bool

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

func (*TimestampFlag) IsVisible added in v2.4.0 

func (f *TimestampFlag) IsVisible() bool

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

func (*TimestampFlag) Names added in v2.1.0 

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

Names returns the names of the flag

func (*TimestampFlag) RunAction added in v2.17.0 

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

RunAction executes flag action if set

func (*TimestampFlag) String added in v2.1.0 

func (f *TimestampFlag) String() string

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

func (*TimestampFlag) TakesValue added in v2.1.0 

func (f *TimestampFlag) TakesValue() bool

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

type Uint64Flag 

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
}

Uint64Flag is a flag with type uint64

func (*Uint64Flag) Apply 

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

Apply populates the flag given the flag set and environment

func (*Uint64Flag) Get added in v2.6.0 

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

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

func (*Uint64Flag) GetCategory added in v2.8.0 

func (f *Uint64Flag) GetCategory() string

GetCategory returns the category for the flag

func (*Uint64Flag) GetDefaultText added in v2.4.4 

func (f *Uint64Flag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Uint64Flag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 added in v2.16.0 

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

Uint64Slice wraps []int64 to satisfy flag.Value

func NewUint64Slice added in v2.16.0 

func NewUint64Slice(defaults ...uint64) *Uint64Slice

NewUint64Slice makes an *Uint64Slice with default values

func (*Uint64Slice) Get added in v2.16.0 

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

Get returns the slice of ints set by this flag

func (*Uint64Slice) Serialize added in v2.16.0 

func (i *Uint64Slice) Serialize() string

Serialize allows Uint64Slice to fulfill Serializer

func (*Uint64Slice) Set added in v2.16.0 

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 added in v2.16.0 

func (i *Uint64Slice) String() string

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

func (*Uint64Slice) Value added in v2.16.0 

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

Value returns the slice of ints set by this flag

func (*Uint64Slice) WithSeparatorSpec added in v2.24.2 

func (i *Uint64Slice) WithSeparatorSpec(spec separatorSpec)

type Uint64SliceFlag added in v2.16.0 

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
}

Uint64SliceFlag is a flag with type *Uint64Slice

func (*Uint64SliceFlag) Apply added in v2.16.0 

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

Apply populates the flag given the flag set and environment

func (*Uint64SliceFlag) Get added in v2.16.0 

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

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

func (*Uint64SliceFlag) GetCategory added in v2.16.0 

func (f *Uint64SliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*Uint64SliceFlag) GetDefaultText added in v2.16.0 

func (f *Uint64SliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*Uint64SliceFlag) GetEnvVars added in v2.16.0 

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

GetEnvVars returns the env vars for this flag

func (*Uint64SliceFlag) GetUsage added in v2.16.0 

func (f *Uint64SliceFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*Uint64SliceFlag) GetValue added in v2.16.0 

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 added in v2.16.0 

func (f *Uint64SliceFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*Uint64SliceFlag) IsSet added in v2.16.0 

func (f *Uint64SliceFlag) IsSet() bool

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

func (*Uint64SliceFlag) IsSliceFlag added in v2.18.0 

func (f *Uint64SliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*Uint64SliceFlag) IsVisible added in v2.16.0 

func (f *Uint64SliceFlag) IsVisible() bool

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

func (*Uint64SliceFlag) Names added in v2.16.0 

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

Names returns the names of the flag

func (*Uint64SliceFlag) RunAction added in v2.27.0 

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

RunAction executes flag action if set

func (*Uint64SliceFlag) String added in v2.16.0 

func (f *Uint64SliceFlag) String() string

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

func (*Uint64SliceFlag) TakesValue added in v2.16.0 

func (f *Uint64SliceFlag) TakesValue() bool

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

func (*Uint64SliceFlag) WithSeparatorSpec added in v2.24.2 

func (f *Uint64SliceFlag) WithSeparatorSpec(spec separatorSpec)

type UintFlag 

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
}

UintFlag is a flag with type uint

func (*UintFlag) Apply 

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

Apply populates the flag given the flag set and environment

func (*UintFlag) Get added in v2.6.0 

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

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

func (*UintFlag) GetCategory added in v2.8.0 

func (f *UintFlag) GetCategory() string

GetCategory returns the category for the flag

func (*UintFlag) GetDefaultText added in v2.4.4 

func (f *UintFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*UintFlag) GetEnvVars added in v2.4.4 

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 added in v2.4.0 

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 added in v2.17.0 

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 added in v2.16.0 

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

UintSlice wraps []int to satisfy flag.Value

func NewUintSlice added in v2.16.0 

func NewUintSlice(defaults ...uint) *UintSlice

NewUintSlice makes an *UintSlice with default values

func (*UintSlice) Get added in v2.16.0 

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

Get returns the slice of ints set by this flag

func (*UintSlice) Serialize added in v2.16.0 

func (i *UintSlice) Serialize() string

Serialize allows UintSlice to fulfill Serializer

func (*UintSlice) Set added in v2.16.0 

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 added in v2.16.0 

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 added in v2.16.0 

func (i *UintSlice) String() string

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

func (*UintSlice) Value added in v2.16.0 

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

Value returns the slice of ints set by this flag

func (*UintSlice) WithSeparatorSpec added in v2.24.2 

func (i *UintSlice) WithSeparatorSpec(spec separatorSpec)

type UintSliceFlag added in v2.16.0 

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
}

UintSliceFlag is a flag with type *UintSlice

func (*UintSliceFlag) Apply added in v2.16.0 

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

Apply populates the flag given the flag set and environment

func (*UintSliceFlag) Get added in v2.16.0 

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

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

func (*UintSliceFlag) GetCategory added in v2.16.0 

func (f *UintSliceFlag) GetCategory() string

GetCategory returns the category for the flag

func (*UintSliceFlag) GetDefaultText added in v2.16.0 

func (f *UintSliceFlag) GetDefaultText() string

GetDefaultText returns the default text for this flag

func (*UintSliceFlag) GetEnvVars added in v2.16.0 

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

GetEnvVars returns the env vars for this flag

func (*UintSliceFlag) GetUsage added in v2.16.0 

func (f *UintSliceFlag) GetUsage() string

GetUsage returns the usage string for the flag

func (*UintSliceFlag) GetValue added in v2.16.0 

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 added in v2.16.0 

func (f *UintSliceFlag) IsRequired() bool

IsRequired returns whether or not the flag is required

func (*UintSliceFlag) IsSet added in v2.16.0 

func (f *UintSliceFlag) IsSet() bool

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

func (*UintSliceFlag) IsSliceFlag added in v2.18.0 

func (f *UintSliceFlag) IsSliceFlag() bool

IsSliceFlag implements DocGenerationSliceFlag.

func (*UintSliceFlag) IsVisible added in v2.16.0 

func (f *UintSliceFlag) IsVisible() bool

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

func (*UintSliceFlag) Names added in v2.16.0 

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

Names returns the names of the flag

func (*UintSliceFlag) RunAction added in v2.27.0 

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

RunAction executes flag action if set

func (*UintSliceFlag) String added in v2.16.0 

func (f *UintSliceFlag) String() string

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

func (*UintSliceFlag) TakesValue added in v2.16.0 

func (f *UintSliceFlag) TakesValue() bool

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

func (*UintSliceFlag) WithSeparatorSpec added in v2.24.2 

func (f *UintSliceFlag) WithSeparatorSpec(spec separatorSpec)

type VisibleFlag added in v2.4.0 

type VisibleFlag interface {
	Flag

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

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

type VisibleFlagCategory added in v2.8.0 

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

VisibleFlagCategory is a category containing flags.

Source Files

View all Source files

Directories

Path Synopsis
internal
build
example-cli
example-hello-world

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.