Movatterモバイル変換

[0]ホーム
URL:

Notice  The highest tagged major version isv3.

cli

packagemodule
v1.22.17Latest Latest
Warning

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

Go to latest Published: Jun 14, 2025 License:MITImports:20Imported by:19,559

Details

Repository

github.com/urfave/cli

Links

README

cli

Run TestsGo ReferenceGo Report Cardcodecov

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

Usage Documentation

Usage documentation forv1 is availableat the docssite or in-tree at./docs/v1/manual.md

Installation

Make sure you have a working Go environment. Go version 1.18+ is supported.

Supported platforms

cli is tested against multiple versions of Go on Linux, and against the latest releasedversion of Go on OS X and Windows. For full details, see./.github/workflows/cli.yml.

Build tags

You can use the following build tags:

urfave_cli_no_docs

When set, this removesToMarkdown andToMan methods, so your applicationwon't be able to call those. This reduces the resulting binary size by about300-400 KB (measured using Go 1.18.1 on Linux/amd64), due to less dependencies.

Usingv1 releases
$ go get github.com/urfave/cli
...import (  "github.com/urfave/cli")...

Documentation

Overview

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

func main() {  cli.NewApp().Run(os.Args)}

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

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

Index

Examples

Constants

This section is empty.

Variables

View Source
var AppHelpTemplate = ``/* 1055-byte string literal not displayed */

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

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

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

ErrWriter is used to write errors to the user. This can be anythingimplementing 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 beoverridden. If the ExtraInfo field is defined on an App, this functionshould not be modified, as HelpPrinterCustom will be used directly in orderto capture the extra information.

View Source
var HelpPrinterCustom helpPrinterCustom = printHelpCustom

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

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

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

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

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

View Source
var VersionPrinter = printVersion

VersionPrinter prints the version for the App

Functions

funcDefaultAppCompleteadded inv1.1.0

func DefaultAppComplete(c *Context)

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

funcDefaultCompleteWithFlagsadded inv1.22.0

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

funcHandleActionadded inv1.15.0

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

HandleAction attempts to figure out which Action signature was used. Ifit's an ActionFunc or a func with the legacy signature for Action, the funcis run!

funcHandleExitCoderadded inv1.15.0

func HandleExitCoder(errerror)

HandleExitCoder checks if the error fulfills the ExitCoder interface, and ifso prints the error to stderr (if it is non-empty) and calls OsExiter with thegiven exit code. If the given error is a MultiError, then this func iscalled on all members of the Errors slice and calls OsExiter with the last exit code.

funcShowAppHelpadded inv1.0.0

func ShowAppHelp(c *Context)error

ShowAppHelp is an action that displays the help.

funcShowAppHelpAndExitadded inv1.20.0

func ShowAppHelpAndExit(c *Context, exitCodeint)

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

funcShowCommandCompletionsadded inv1.1.0

func ShowCommandCompletions(ctx *Context, commandstring)

ShowCommandCompletions prints the custom completions for a given command

funcShowCommandHelpadded inv1.0.0

func ShowCommandHelp(ctx *Context, commandstring)error

ShowCommandHelp prints help for the given command

funcShowCommandHelpAndExitadded inv1.20.0

func ShowCommandHelpAndExit(c *Context, commandstring, codeint)

ShowCommandHelpAndExit - exits with code after showing help

funcShowCompletionsadded inv1.1.0

func ShowCompletions(c *Context)

ShowCompletions prints the lists of commands within a given context

funcShowSubcommandHelpadded inv1.1.0

func ShowSubcommandHelp(c *Context)error

ShowSubcommandHelp prints help for the given subcommand

funcShowVersionadded inv1.0.0

func ShowVersion(c *Context)

ShowVersion prints the version number of the App

Types

typeActionFuncadded inv1.15.0

type ActionFunc func(*Context)error

ActionFunc is the action to execute when no subcommands are specified

typeAfterFuncadded inv1.15.0

type AfterFunc func(*Context)error

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

typeApp

type App struct {// The name of the program. Defaults to path.Base(os.Args[0])Namestring// Full name of command for help, defaults to NameHelpNamestring// Description of the program.Usagestring// Text to override the USAGE section of helpUsageTextstring// Description of the program argument format.ArgsUsagestring// Version of the programVersionstring// Description of the programDescriptionstring// List of commands to executeCommands []Command// List of flags to parseFlags []Flag// Boolean to enable bash completion commandsEnableBashCompletionbool// Boolean to hide built-in help commandHideHelpbool// Boolean to hide built-in version flag and the VERSION section of helpHideVersionbool// An action to execute when the bash-completion flag is setBashCompleteBashCompleteFunc// 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 runBeforeBeforeFunc// An action to execute after any subcommands are run, but after the subcommand has finished// It is run even if Action() panicsAfterAfterFunc// The action to execute when no subcommands are specified// Expects a `cli.ActionFunc` but will accept the *deprecated* signature of `func(*cli.Context) {}`// *Note*: support for the deprecated `Action` signature will be removed in a future versionAction interface{}// Execute this function if the proper command cannot be foundCommandNotFoundCommandNotFoundFunc// Execute this function if an usage error occursOnUsageErrorOnUsageErrorFunc// Compilation dateCompiledtime.Time// List of all authors who contributedAuthors []Author// Copyright of the binary if anyCopyrightstring// Name of Author (Note: Use App.Authors, this is deprecated)Authorstring// Email of Author (Note: Use App.Authors, this is deprecated)Emailstring// Writer writer to write output toWriterio.Writer// ErrWriter writes error outputErrWriterio.Writer// Execute this function to handle ExitErrors. If not provided, HandleExitCoder is provided to// function as a default, so this is optional.ExitErrHandlerExitErrHandlerFunc// Other custom infoMetadata 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.CustomAppHelpTemplatestring// Boolean to enable short-option handling so user can combine several// single-character bool arguements into one// i.e. foobar -o -v -> foobar -ovUseShortOptionHandlingbool// contains filtered or unexported fields}

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

funcNewApp

func NewApp() *App

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

func (*App)Categoriesadded inv1.14.0

func (a *App) Categories()CommandCategories

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

func (*App)Commandadded inv1.0.0

func (a *App) Command(namestring) *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) (errerror)

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

Example
// set args for examples sakeos.Args = []string{"greet", "--name", "Jeremy"}app := NewApp()app.Name = "greet"app.Flags = []Flag{StringFlag{Name: "name", Value: "bob", Usage: "a name to say"},}app.Action = func(c *Context) error {fmt.Printf("Hello %v\n", c.String("name"))return nil}app.UsageText = "app [first_arg] [second_arg]"app.Author = "Harrison"app.Email = "harrison@lolwut.com"app.Authors = []Author{{Name: "Oliver Allen", Email: "oliver@toyshop.com"}}_ = app.Run(os.Args)
Output:Hello Jeremy
Example (AppHelp)
// set args for examples sakeos.Args = []string{"greet", "help"}app := NewApp()app.Name = "greet"app.Version = "0.1.0"app.Description = "This is how we describe greet the app"app.Authors = []Author{{Name: "Harrison", Email: "harrison@lolwut.com"},{Name: "Oliver Allen", Email: "oliver@toyshop.com"},}app.Flags = []Flag{StringFlag{Name: "name", Value: "bob", Usage: "a name to say"},}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},},}_ = app.Run(os.Args)
Output:NAME:   greet - A new cli applicationUSAGE:   greet [global options] command [command options] [arguments...]VERSION:   0.1.0DESCRIPTION:   This is how we describe greet the appAUTHORS:   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 commandGLOBAL OPTIONS:   --name value   a name to say (default: "bob")   --help, -h     show help   --version, -v  print the version
Example (BashComplete)
// set args for examples sakeos.Args = []string{"greet", "--generate-bash-completion"}app := NewApp()app.Name = "greet"app.EnableBashCompletion = trueapp.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:describeitdnexthelph
Example (BashComplete_withLongFlag)
os.Args = []string{"greet", "--s", "--generate-bash-completion"}app := NewApp()app.Name = "greet"app.EnableBashCompletion = trueapp.Flags = []Flag{IntFlag{Name: "other,o",},StringFlag{Name: "xyz,x",},StringFlag{Name: "some-flag,s",},StringFlag{Name: "similar-flag",},}_ = app.Run(os.Args)
Output:--some-flag--similar-flag
Example (BashComplete_withMultipleLongFlag)
os.Args = []string{"greet", "--st", "--generate-bash-completion"}app := NewApp()app.Name = "greet"app.EnableBashCompletion = trueapp.Flags = []Flag{IntFlag{Name: "int-flag,i",},StringFlag{Name: "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.Args = []string{"greet", "-", "--generate-bash-completion"}app := NewApp()app.Name = "greet"app.EnableBashCompletion = trueapp.Flags = []Flag{IntFlag{Name: "other,o",},StringFlag{Name: "xyz,x",},}_ = app.Run(os.Args)
Output:--other-o--xyz-x--help-h
Example (CommandHelp)
// set args for examples sakeos.Args = []string{"greet", "h", "describeit"}app := NewApp()app.Name = "greet"app.Flags = []Flag{StringFlag{Name: "name", Value: "bob", Usage: "a name to say"},}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},},}_ = app.Run(os.Args)
Output:NAME:   greet describeit - use it to see a descriptionUSAGE:   greet describeit [arguments...]DESCRIPTION:   This is how we describe describeit the function
Example (NoAction)
app := App{}app.Name = "greet"_ = app.Run([]string{"greet"})
Output:NAME:   greetUSAGE:    [global options] command [command options] [arguments...]COMMANDS:   help, h  Shows a list of commands or help for one commandGLOBAL OPTIONS:   --help, -h  show help
Example (Subcommand)
// set args for examples sakeos.Args = []string{"say", "hi", "english", "--name", "Jeremy"}app := NewApp()app.Name = "say"app.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{}app.Name = "greet"app.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:    describeit - use it to see a descriptionUSAGE:    describeit [arguments...]DESCRIPTION:   This is how we describe describeit the function
Example (ZshComplete)
// set args for examples sakeos.Args = []string{"greet", "--generate-bash-completion"}_ = os.Setenv("_CLI_ZSH_AUTOCOMPLETE_HACK", "1")app := NewApp()app.Name = "greet"app.EnableBashCompletion = trueapp.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 descriptiond:use it to see a descriptionnext:next examplehelp:Shows a list of commands or help for one commandh:Shows a list of commands or help for one command

func (*App)RunAndExitOnErrordeprecatedadded inv1.1.0

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.ExitCoderto cli.App.Run. This will cause the application to exit with the given erorcode in the cli.ExitCoder

func (*App)RunAsSubcommandadded inv1.1.0

func (a *App) RunAsSubcommand(ctx *Context) (errerror)

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

func (*App)Setupadded inv1.17.0

func (a *App) Setup()

Setup runs initialization code to ensure all data structures are ready for`Run` or inspection prior to `Run`. It is internally called by `Run`, butwill return early if setup has already happened.

func (*App)ToFishCompletionadded inv1.22.0

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)ToManadded inv1.22.0

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)ToMarkdownadded inv1.22.0

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)VisibleCategoriesadded inv1.17.0

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

VisibleCategories returns a slice of categories and commands that areHidden=false

func (*App)VisibleCommandsadded inv1.17.0

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

VisibleCommands returns a slice of the Commands with Hidden=false

func (*App)VisibleFlagsadded inv1.16.0

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

VisibleFlags returns a slice of the Flags with Hidden=false

typeArgsadded inv1.1.0

type Args []string

Args contains apps console arguments

func (Args)Firstadded inv1.1.0

func (aArgs) First()string

First returns the first argument, or else a blank string

func (Args)Getadded inv1.1.0

func (aArgs) Get(nint)string

Get returns the nth argument, or else a blank string

func (Args)Presentadded inv1.1.0

func (aArgs) Present()bool

Present checks if there are any arguments present

func (Args)Swapadded inv1.1.0

func (aArgs) Swap(from, toint)error

Swap swaps arguments at the given indexes

func (Args)Tailadded inv1.1.0

func (aArgs) Tail() []string

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

typeAuthoradded inv1.6.0

type Author struct {Namestring// The Authors nameEmailstring// The Authors email}

Author represents someone who has contributed to a cli project.

func (Author)Stringadded inv1.6.0

func (aAuthor) String()string

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

typeBashCompleteFuncadded inv1.15.0

type BashCompleteFunc func(*Context)

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

typeBeforeFuncadded inv1.15.0

type BeforeFunc func(*Context)error

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

typeBoolFlag

type BoolFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolDestination *bool}

BoolFlag is a flag with type bool

func (BoolFlag)Apply

func (fBoolFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (BoolFlag)ApplyWithErroradded inv1.19.0

func (fBoolFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (BoolFlag)GetNameadded inv1.11.1

func (fBoolFlag) GetName()string

GetName returns the name of the flag

func (BoolFlag)GetUsageadded inv1.22.0

func (fBoolFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (BoolFlag)GetValueadded inv1.22.0

func (fBoolFlag) GetValue()string

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

func (BoolFlag)IsRequiredadded inv1.21.0

func (fBoolFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (BoolFlag)String

func (fBoolFlag) String()string

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

func (BoolFlag)TakesValueadded inv1.22.0

func (fBoolFlag) TakesValue()bool

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

typeBoolTFlagadded inv1.1.0

type BoolTFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolDestination *bool}

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

func (BoolTFlag)Applyadded inv1.1.0

func (fBoolTFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (BoolTFlag)ApplyWithErroradded inv1.19.0

func (fBoolTFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (BoolTFlag)GetNameadded inv1.11.1

func (fBoolTFlag) GetName()string

GetName returns the name of the flag

func (BoolTFlag)GetUsageadded inv1.22.0

func (fBoolTFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (BoolTFlag)GetValueadded inv1.22.0

func (fBoolTFlag) GetValue()string

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

func (BoolTFlag)IsRequiredadded inv1.21.0

func (fBoolTFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (BoolTFlag)Stringadded inv1.1.0

func (fBoolTFlag) String()string

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

func (BoolTFlag)TakesValueadded inv1.22.0

func (fBoolTFlag) TakesValue()bool

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

typeCommand

type Command struct {// The name of the commandNamestring// short name of the command. Typically one character (deprecated, use `Aliases`)ShortNamestring// A list of aliases for the commandAliases []string// A short description of the usage of this commandUsagestring// Custom text to show on USAGE section of helpUsageTextstring// A longer explanation of how the command worksDescriptionstring// A short description of the arguments of this commandArgsUsagestring// The category the command is part ofCategorystring// The function to call when checking for bash command completionsBashCompleteBashCompleteFunc// 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 runBeforeBeforeFunc// An action to execute after any subcommands are run, but after the subcommand has finished// It is run even if Action() panicsAfterAfterFunc// The function to call when this command is invokedAction interface{}// Execute this function if a usage error occurs.OnUsageErrorOnUsageErrorFunc// List of child commandsSubcommandsCommands// List of flags to parseFlags []Flag// Treat all flags as normal arguments if trueSkipFlagParsingbool// Skip argument reordering which attempts to move flags before arguments,// but only works if all flags appear after all arguments. This behavior was// removed n version 2 since it only works under specific conditions so we// backport here by exposing it as an option for compatibility.SkipArgReorderbool// Boolean to hide built-in help commandHideHelpbool// Boolean to hide this command from help or completionHiddenbool// Boolean to enable short-option handling so user can combine several// single-character bool arguments into one// i.e. foobar -o -v -> foobar -ovUseShortOptionHandlingbool// Full name of command for help, defaults to full command name, including parent commands.HelpNamestring// 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.CustomHelpTemplatestring// contains filtered or unexported fields}

Command is a subcommand for a cli.App.

func (Command)FullNameadded inv1.9.0

func (cCommand) 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 (cCommand) HasName(namestring)bool

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

func (Command)Namesadded inv1.6.0

func (cCommand) Names() []string

Names returns the names including short names and aliases.

func (Command)Run

func (cCommand) Run(ctx *Context) (errerror)

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

func (Command)VisibleFlagsadded inv1.16.0

func (cCommand) VisibleFlags() []Flag

VisibleFlags returns a slice of the Flags with Hidden=false

typeCommandCategoriesadded inv1.14.0

type CommandCategories []*CommandCategory

CommandCategories is a slice of *CommandCategory.

func (CommandCategories)AddCommandadded inv1.14.0

func (cCommandCategories) AddCommand(categorystring, commandCommand)CommandCategories

AddCommand adds a command to a category.

func (CommandCategories)Lenadded inv1.14.0

func (cCommandCategories) Len()int

func (CommandCategories)Lessadded inv1.14.0

func (cCommandCategories) Less(i, jint)bool

func (CommandCategories)Swapadded inv1.14.0

func (cCommandCategories) Swap(i, jint)

typeCommandCategoryadded inv1.14.0

type CommandCategory struct {NamestringCommandsCommands}

CommandCategory is a category containing commands.

func (*CommandCategory)VisibleCommandsadded inv1.17.0

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

VisibleCommands returns a slice of the Commands with Hidden=false

typeCommandNotFoundFuncadded inv1.15.0

type CommandNotFoundFunc func(*Context,string)

CommandNotFoundFunc is executed if the proper command cannot be found

typeCommandsadded inv1.14.0

type Commands []Command

Commands is a slice of Command

typeCommandsByNameadded inv1.20.0

type CommandsByName []Command

func (CommandsByName)Lenadded inv1.20.0

func (cCommandsByName) Len()int

func (CommandsByName)Lessadded inv1.20.0

func (cCommandsByName) Less(i, jint)bool

func (CommandsByName)Swapadded inv1.20.0

func (cCommandsByName) Swap(i, jint)

typeContext

type Context struct {App     *AppCommandCommand// contains filtered or unexported fields}

Context is a type that is passed through toeach Handler action in a cli application. Contextcan be used to retrieve context-specific Args andparsed command-line options.

funcNewContext

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

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

func (*Context)Args

func (c *Context) Args()Args

Args returns the command line arguments associated with the context.

func (*Context)Bool

func (c *Context) Bool(namestring)bool

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

func (*Context)BoolTadded inv1.1.0

func (c *Context) BoolT(namestring)bool

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

func (*Context)Durationadded inv1.3.0

func (c *Context) Duration(namestring)time.Duration

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

func (*Context)FlagNamesadded inv1.3.0

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

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

func (*Context)Float64added inv1.1.0

func (c *Context) Float64(namestring)float64

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

func (*Context)Genericadded inv1.1.0

func (c *Context) Generic(namestring) interface{}

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

func (*Context)GlobalBool

func (c *Context) GlobalBool(namestring)bool

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

func (*Context)GlobalBoolTadded inv1.17.0

func (c *Context) GlobalBoolT(namestring)bool

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

func (*Context)GlobalDurationadded inv1.3.0

func (c *Context) GlobalDuration(namestring)time.Duration

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

func (*Context)GlobalFlagNamesadded inv1.3.1

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

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

func (*Context)GlobalFloat64added inv1.15.0

func (c *Context) GlobalFloat64(namestring)float64

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

func (*Context)GlobalGenericadded inv1.1.0

func (c *Context) GlobalGeneric(namestring) interface{}

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

func (*Context)GlobalInt

func (c *Context) GlobalInt(namestring)int

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

func (*Context)GlobalInt64added inv1.18.0

func (c *Context) GlobalInt64(namestring)int64

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

func (*Context)GlobalInt64Sliceadded inv1.18.0

func (c *Context) GlobalInt64Slice(namestring) []int64

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

func (*Context)GlobalIntSliceadded inv1.0.0

func (c *Context) GlobalIntSlice(namestring) []int

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

func (*Context)GlobalIsSetadded inv1.3.1

func (c *Context) GlobalIsSet(namestring)bool

GlobalIsSet determines if the global flag was actually set

func (*Context)GlobalSetadded inv1.15.0

func (c *Context) GlobalSet(name, valuestring)error

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

func (*Context)GlobalString

func (c *Context) GlobalString(namestring)string

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

func (*Context)GlobalStringSliceadded inv1.0.0

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

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

func (*Context)GlobalUintadded inv1.18.0

func (c *Context) GlobalUint(namestring)uint

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

func (*Context)GlobalUint64added inv1.18.0

func (c *Context) GlobalUint64(namestring)uint64

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

func (*Context)Int

func (c *Context) Int(namestring)int

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

func (*Context)Int64added inv1.18.0

func (c *Context) Int64(namestring)int64

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

func (*Context)Int64Sliceadded inv1.18.0

func (c *Context) Int64Slice(namestring) []int64

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

func (*Context)IntSliceadded inv1.0.0

func (c *Context) IntSlice(namestring) []int

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

func (*Context)IsSetadded inv1.1.0

func (c *Context) IsSet(namestring)bool

IsSet determines if the flag was actually set

func (*Context)NArgadded inv1.13.0

func (c *Context) NArg()int

NArg returns the number of the command line arguments.

func (*Context)NumFlagsadded inv1.6.0

func (c *Context) NumFlags()int

NumFlags returns the number of flags set

func (*Context)Parentadded inv1.8.0

func (c *Context) Parent() *Context

Parent returns the parent context, if any

func (*Context)Setadded inv1.15.0

func (c *Context) Set(name, valuestring)error

Set sets a context flag to a value.

func (*Context)String

func (c *Context) String(namestring)string

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

func (*Context)StringSliceadded inv1.0.0

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

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

func (*Context)Uintadded inv1.18.0

func (c *Context) Uint(namestring)uint

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

func (*Context)Uint64added inv1.18.0

func (c *Context) Uint64(namestring)uint64

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

typeDocGenerationFlagadded inv1.22.0

type DocGenerationFlag interface {Flag// TakesValue returns true if the flag takes a value, otherwise falseTakesValue()bool// GetUsage returns the usage string for the flagGetUsage()string// GetValue returns the flags value as string representation and an empty// string if the flag takes no value at all.GetValue()string}

DocGenerationFlag is an interface that allows documentation generation for the flag

typeDurationFlagadded inv1.3.0

type DurationFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValuetime.DurationDestination *time.Duration}

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

func (DurationFlag)Applyadded inv1.3.0

func (fDurationFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (DurationFlag)ApplyWithErroradded inv1.19.0

func (fDurationFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (DurationFlag)GetNameadded inv1.11.1

func (fDurationFlag) GetName()string

GetName returns the name of the flag

func (DurationFlag)GetUsageadded inv1.22.0

func (fDurationFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (DurationFlag)GetValueadded inv1.22.0

func (fDurationFlag) GetValue()string

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

func (DurationFlag)IsRequiredadded inv1.21.0

func (fDurationFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (DurationFlag)Stringadded inv1.3.0

func (fDurationFlag) String()string

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

func (DurationFlag)TakesValueadded inv1.22.0

func (fDurationFlag) TakesValue()bool

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

typeErrorFormatteradded inv1.19.0

type ErrorFormatter interface {Format(sfmt.State, verbrune)}

typeExitCoderadded inv1.15.0

type ExitCoder interface {errorExitCode()int}

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

typeExitErrHandlerFuncadded inv1.21.0

type ExitErrHandlerFunc func(context *Context, errerror)

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

typeExitErroradded inv1.15.0

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

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

funcNewExitErroradded inv1.15.0

func NewExitError(message interface{}, exitCodeint) *ExitError

NewExitError makes a new *ExitError

func (*ExitError)Erroradded inv1.15.0

func (ee *ExitError) Error()string

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

func (*ExitError)ExitCodeadded inv1.15.0

func (ee *ExitError) ExitCode()int

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

typeFlag

type Flag interface {fmt.Stringer// Apply Flag settings to the given flag setApply(*flag.FlagSet)GetName()string}

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

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

BashCompletionFlag enables bash-completion for all commands and subcommands

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

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

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

VersionFlag prints the version for the application

typeFlagEnvHintFuncadded inv1.21.0

type FlagEnvHintFunc func(envVar, strstring)string

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

var FlagEnvHinterFlagEnvHintFunc = withEnvHint

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

typeFlagFileHintFuncadded inv1.21.0

type FlagFileHintFunc func(filePath, strstring)string

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

var FlagFileHinterFlagFileHintFunc = withFileHint

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

typeFlagNamePrefixFuncadded inv1.21.0

type FlagNamePrefixFunc func(fullName, placeholderstring)string

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

var FlagNamePrefixerFlagNamePrefixFunc = prefixedNames

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

typeFlagStringFuncadded inv1.17.0

type FlagStringFunc func(Flag)string

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

var FlagStringerFlagStringFunc = stringifyFlag

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

typeFlagsByNameadded inv1.19.0

type FlagsByName []Flag

FlagsByName is a slice of Flag.

func (FlagsByName)Lenadded inv1.19.0

func (fFlagsByName) Len()int

func (FlagsByName)Lessadded inv1.19.0

func (fFlagsByName) Less(i, jint)bool

func (FlagsByName)Swapadded inv1.19.0

func (fFlagsByName) Swap(i, jint)

typeFloat64Flagadded inv1.1.0

type Float64Flag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValuefloat64Destination *float64}

Float64Flag is a flag with type float64

func (Float64Flag)Applyadded inv1.1.0

func (fFloat64Flag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (Float64Flag)ApplyWithErroradded inv1.19.0

func (fFloat64Flag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (Float64Flag)GetNameadded inv1.11.1

func (fFloat64Flag) GetName()string

GetName returns the name of the flag

func (Float64Flag)GetUsageadded inv1.22.0

func (fFloat64Flag) GetUsage()string

GetUsage returns the usage string for the flag

func (Float64Flag)GetValueadded inv1.22.0

func (fFloat64Flag) GetValue()string

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

func (Float64Flag)IsRequiredadded inv1.21.0

func (fFloat64Flag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (Float64Flag)Stringadded inv1.1.0

func (fFloat64Flag) String()string

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

func (Float64Flag)TakesValueadded inv1.22.0

func (fFloat64Flag) TakesValue()bool

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

typeGenericadded inv1.1.0

type Generic interface {Set(valuestring)errorString()string}

Generic is a generic parseable type identified by a specific flag

typeGenericFlagadded inv1.1.0

type GenericFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolTakesFileboolValueGeneric}

GenericFlag is a flag with type Generic

func (GenericFlag)Applyadded inv1.1.0

func (fGenericFlag) Apply(set *flag.FlagSet)

Apply takes the flagset and calls Set on the generic flag with the valueprovided by the user for parsing by the flagIgnores parsing errors

func (GenericFlag)ApplyWithErroradded inv1.19.0

func (fGenericFlag) ApplyWithError(set *flag.FlagSet)error

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

func (GenericFlag)GetNameadded inv1.11.1

func (fGenericFlag) GetName()string

GetName returns the name of the flag

func (GenericFlag)GetUsageadded inv1.22.0

func (fGenericFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (GenericFlag)GetValueadded inv1.22.0

func (fGenericFlag) GetValue()string

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

func (GenericFlag)IsRequiredadded inv1.21.0

func (fGenericFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (GenericFlag)Stringadded inv1.1.0

func (fGenericFlag) String()string

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

func (GenericFlag)TakesValueadded inv1.22.0

func (fGenericFlag) TakesValue()bool

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

typeInt64Flagadded inv1.18.0

type Int64Flag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValueint64Destination *int64}

Int64Flag is a flag with type int64

func (Int64Flag)Applyadded inv1.18.0

func (fInt64Flag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (Int64Flag)ApplyWithErroradded inv1.19.0

func (fInt64Flag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (Int64Flag)GetNameadded inv1.18.0

func (fInt64Flag) GetName()string

GetName returns the name of the flag

func (Int64Flag)GetUsageadded inv1.22.0

func (fInt64Flag) GetUsage()string

GetUsage returns the usage string for the flag

func (Int64Flag)GetValueadded inv1.22.0

func (fInt64Flag) GetValue()string

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

func (Int64Flag)IsRequiredadded inv1.21.0

func (fInt64Flag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (Int64Flag)Stringadded inv1.18.0

func (fInt64Flag) String()string

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

func (Int64Flag)TakesValueadded inv1.22.0

func (fInt64Flag) TakesValue()bool

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

typeInt64Sliceadded inv1.18.0

type Int64Slice []int64

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

func (*Int64Slice)Getadded inv1.19.0

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

Get returns the slice of ints set by this flag

func (*Int64Slice)Setadded inv1.18.0

func (f *Int64Slice) Set(valuestring)error

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

func (*Int64Slice)Stringadded inv1.18.0

func (f *Int64Slice) String()string

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

func (*Int64Slice)Valueadded inv1.18.0

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

Value returns the slice of ints set by this flag

typeInt64SliceFlagadded inv1.18.0

type Int64SliceFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValue    *Int64Slice}

Int64SliceFlag is a flag with type *Int64Slice

func (Int64SliceFlag)Applyadded inv1.18.0

func (fInt64SliceFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (Int64SliceFlag)ApplyWithErroradded inv1.19.0

func (fInt64SliceFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (Int64SliceFlag)GetNameadded inv1.18.0

func (fInt64SliceFlag) GetName()string

GetName returns the name of the flag

func (Int64SliceFlag)GetUsageadded inv1.22.0

func (fInt64SliceFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (Int64SliceFlag)GetValueadded inv1.22.0

func (fInt64SliceFlag) GetValue()string

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

func (Int64SliceFlag)IsRequiredadded inv1.21.0

func (fInt64SliceFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (Int64SliceFlag)Stringadded inv1.18.0

func (fInt64SliceFlag) String()string

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

func (Int64SliceFlag)TakesValueadded inv1.22.0

func (fInt64SliceFlag) TakesValue()bool

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

typeIntFlag

type IntFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValueintDestination *int}

IntFlag is a flag with type int

func (IntFlag)Apply

func (fIntFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (IntFlag)ApplyWithErroradded inv1.19.0

func (fIntFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (IntFlag)GetNameadded inv1.11.1

func (fIntFlag) GetName()string

GetName returns the name of the flag

func (IntFlag)GetUsageadded inv1.22.0

func (fIntFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (IntFlag)GetValueadded inv1.22.0

func (fIntFlag) GetValue()string

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

func (IntFlag)IsRequiredadded inv1.21.0

func (fIntFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (IntFlag)String

func (fIntFlag) String()string

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

func (IntFlag)TakesValueadded inv1.22.0

func (fIntFlag) TakesValue()bool

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

typeIntSliceadded inv1.0.0

type IntSlice []int

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

func (*IntSlice)Getadded inv1.19.0

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

Get returns the slice of ints set by this flag

func (*IntSlice)Setadded inv1.0.0

func (f *IntSlice) Set(valuestring)error

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

func (*IntSlice)Stringadded inv1.0.0

func (f *IntSlice) String()string

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

func (*IntSlice)Valueadded inv1.0.0

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

Value returns the slice of ints set by this flag

typeIntSliceFlagadded inv1.0.0

type IntSliceFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValue    *IntSlice}

IntSliceFlag is a flag with type *IntSlice

func (IntSliceFlag)Applyadded inv1.0.0

func (fIntSliceFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (IntSliceFlag)ApplyWithErroradded inv1.19.0

func (fIntSliceFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (IntSliceFlag)GetNameadded inv1.11.1

func (fIntSliceFlag) GetName()string

GetName returns the name of the flag

func (IntSliceFlag)GetUsageadded inv1.22.0

func (fIntSliceFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (IntSliceFlag)GetValueadded inv1.22.0

func (fIntSliceFlag) GetValue()string

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

func (IntSliceFlag)IsRequiredadded inv1.21.0

func (fIntSliceFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (IntSliceFlag)Stringadded inv1.0.0

func (fIntSliceFlag) String()string

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

func (IntSliceFlag)TakesValueadded inv1.22.0

func (fIntSliceFlag) TakesValue()bool

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

typeMultiErroradded inv1.7.1

type MultiError struct {Errors []error}

MultiError is an error that wraps multiple errors.

funcNewMultiErroradded inv1.7.1

func NewMultiError(err ...error)MultiError

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

func (MultiError)Erroradded inv1.7.1

func (mMultiError) Error()string

Error implements the error interface.

typeOnUsageErrorFuncadded inv1.15.0

type OnUsageErrorFunc func(context *Context, errerror, isSubcommandbool)error

OnUsageErrorFunc is executed if an usage error occurs. This is useful for displayingcustomized usage error messages. This function is able to replace theoriginal error messages. If this function is not set, the "Incorrect usage"is displayed and the execution is interrupted.

typeRequiredFlagadded inv1.21.0

type RequiredFlag interface {FlagIsRequired()bool}

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

typeStringFlag

type StringFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolTakesFileboolValuestringDestination *string}

StringFlag is a flag with type string

func (StringFlag)Apply

func (fStringFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (StringFlag)ApplyWithErroradded inv1.19.0

func (fStringFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (StringFlag)GetNameadded inv1.11.1

func (fStringFlag) GetName()string

GetName returns the name of the flag

func (StringFlag)GetUsageadded inv1.22.0

func (fStringFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (StringFlag)GetValueadded inv1.22.0

func (fStringFlag) GetValue()string

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

func (StringFlag)IsRequiredadded inv1.21.0

func (fStringFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (StringFlag)String

func (fStringFlag) String()string

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

func (StringFlag)TakesValueadded inv1.22.0

func (fStringFlag) TakesValue()bool

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

typeStringSliceadded inv1.0.0

type StringSlice []string

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

func (*StringSlice)Getadded inv1.19.0

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

Get returns the slice of strings set by this flag

func (*StringSlice)Setadded inv1.0.0

func (f *StringSlice) Set(valuestring)error

Set appends the string value to the list of values

func (*StringSlice)Stringadded inv1.0.0

func (f *StringSlice) String()string

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

func (*StringSlice)Valueadded inv1.0.0

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

Value returns the slice of strings set by this flag

typeStringSliceFlagadded inv1.0.0

type StringSliceFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolTakesFileboolValue     *StringSlice}

StringSliceFlag is a flag with type *StringSlice

func (StringSliceFlag)Applyadded inv1.0.0

func (fStringSliceFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (StringSliceFlag)ApplyWithErroradded inv1.19.0

func (fStringSliceFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (StringSliceFlag)GetNameadded inv1.11.1

func (fStringSliceFlag) GetName()string

GetName returns the name of the flag

func (StringSliceFlag)GetUsageadded inv1.22.0

func (fStringSliceFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (StringSliceFlag)GetValueadded inv1.22.0

func (fStringSliceFlag) GetValue()string

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

func (StringSliceFlag)IsRequiredadded inv1.21.0

func (fStringSliceFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (StringSliceFlag)Stringadded inv1.0.0

func (fStringSliceFlag) String()string

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

func (StringSliceFlag)TakesValueadded inv1.22.0

func (fStringSliceFlag) TakesValue()bool

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

typeUint64Flagadded inv1.18.0

type Uint64Flag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValueuint64Destination *uint64}

Uint64Flag is a flag with type uint64

func (Uint64Flag)Applyadded inv1.18.0

func (fUint64Flag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (Uint64Flag)ApplyWithErroradded inv1.19.0

func (fUint64Flag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (Uint64Flag)GetNameadded inv1.18.0

func (fUint64Flag) GetName()string

GetName returns the name of the flag

func (Uint64Flag)GetUsageadded inv1.22.0

func (fUint64Flag) GetUsage()string

GetUsage returns the usage string for the flag

func (Uint64Flag)GetValueadded inv1.22.0

func (fUint64Flag) GetValue()string

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

func (Uint64Flag)IsRequiredadded inv1.21.0

func (fUint64Flag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (Uint64Flag)Stringadded inv1.18.0

func (fUint64Flag) String()string

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

func (Uint64Flag)TakesValueadded inv1.22.0

func (fUint64Flag) TakesValue()bool

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

typeUintFlagadded inv1.18.0

type UintFlag struct {NamestringUsagestringEnvVarstringFilePathstringRequiredboolHiddenboolValueuintDestination *uint}

UintFlag is a flag with type uint

func (UintFlag)Applyadded inv1.18.0

func (fUintFlag) Apply(set *flag.FlagSet)

Apply populates the flag given the flag set and environmentIgnores errors

func (UintFlag)ApplyWithErroradded inv1.19.0

func (fUintFlag) ApplyWithError(set *flag.FlagSet)error

ApplyWithError populates the flag given the flag set and environment

func (UintFlag)GetNameadded inv1.18.0

func (fUintFlag) GetName()string

GetName returns the name of the flag

func (UintFlag)GetUsageadded inv1.22.0

func (fUintFlag) GetUsage()string

GetUsage returns the usage string for the flag

func (UintFlag)GetValueadded inv1.22.0

func (fUintFlag) GetValue()string

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

func (UintFlag)IsRequiredadded inv1.21.0

func (fUintFlag) IsRequired()bool

IsRequired returns whether or not the flag is required

func (UintFlag)Stringadded inv1.18.0

func (fUintFlag) String()string

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

func (UintFlag)TakesValueadded inv1.22.0

func (fUintFlag) TakesValue()bool

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

Source Files

View all Source files

Directories

PathSynopsis
docsmodule

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp