cli: github.com/urfave/cli Index | Examples | Files | Directories

package cli

import "github.com/urfave/cli"

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

func main() {
  cli.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

Package Files

app.go category.go cli.go command.go context.go errors.go flag.go flag_generated.go funcs.go help.go sort.go

Variables

❖
var AppHelpTemplate = "" /* 974 byte string literal not displayed */

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

❖
var CommandHelpTemplate = "" /* 406 byte string literal not displayed */

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

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

❖
var HelpPrinter helpPrinter = printHelp

HelpPrinter is a function that writes the help output. If not set a default is used. The function signature is: func(w io.Writer, templ string, data interface{})

❖
var HelpPrinterCustom helpPrinterCustom = printHelpCustom

HelpPrinterCustom is same as HelpPrinter but takes a custom function for template function map.

❖
var OsExiter = os.Exit

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

❖
var SubcommandHelpTemplate = "" /* 509 byte string literal not displayed */

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

❖
var VersionPrinter = printVersion

VersionPrinter prints the version for the App

func DefaultAppComplete Uses

❖
func DefaultAppComplete(c *Context)

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

func HandleAction Uses

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

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

func HandleExitCoder Uses

❖
func HandleExitCoder(err error)

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

func ShowAppHelp Uses

❖
func ShowAppHelp(c *Context) (err error)

ShowAppHelp is an action that displays the help.

func ShowAppHelpAndExit Uses

❖
func ShowAppHelpAndExit(c *Context, exitCode int)

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

func ShowCommandCompletions Uses

❖
func ShowCommandCompletions(ctx *Context, command string)

ShowCommandCompletions prints the custom completions for a given command

func ShowCommandHelp Uses

❖
func ShowCommandHelp(ctx *Context, command string) error

ShowCommandHelp prints help for the given command

func ShowCommandHelpAndExit Uses

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

ShowCommandHelpAndExit - exits with code after showing help

func ShowCompletions Uses

❖
func ShowCompletions(c *Context)

ShowCompletions prints the lists of commands within a given context

func ShowSubcommandHelp Uses

❖
func ShowSubcommandHelp(c *Context) error

ShowSubcommandHelp prints help for the given subcommand

func ShowVersion Uses

❖
func ShowVersion(c *Context)

ShowVersion prints the version number of the App

type ActionFunc Uses

❖
type ActionFunc func(*Context) error

ActionFunc is the action to execute when no subcommands are specified

type AfterFunc Uses

❖
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 Uses

❖
type App struct {
    // The name of the program. Defaults to path.Base(os.Args[0])
    Name string
    // Full name of command for help, defaults to Name
    HelpName string
    // Description of the program.
    Usage string
    // Text to override the USAGE section of help
    UsageText string
    // Description of the program argument format.
    ArgsUsage string
    // Version of the program
    Version string
    // Description of the program
    Description string
    // List of commands to execute
    Commands []Command
    // List of flags to parse
    Flags []Flag
    // Boolean to enable bash completion commands
    EnableBashCompletion bool
    // Boolean to hide built-in help command
    HideHelp bool
    // Boolean to hide built-in version flag and the VERSION section of help
    HideVersion bool

    // An action to execute when the bash-completion flag is set
    BashComplete BashCompleteFunc
    // An action to execute before any subcommands are run, but after the context is ready
    // If a non-nil error is returned, no subcommands are run
    Before BeforeFunc
    // An action to execute after any subcommands are run, but after the subcommand has finished
    // It is run even if Action() panics
    After AfterFunc

    // The action to execute when no subcommands are specified
    // Expects a `cli.ActionFunc` but will accept the *deprecated* signature of `func(*cli.Context) {}`
    // *Note*: support for the deprecated `Action` signature will be removed in a future version
    Action interface{}

    // Execute this function if the proper command cannot be found
    CommandNotFound CommandNotFoundFunc
    // Execute this function if an usage error occurs
    OnUsageError OnUsageErrorFunc
    // Compilation date
    Compiled time.Time
    // List of all authors who contributed
    Authors []Author
    // Copyright of the binary if any
    Copyright string
    // Name of Author (Note: Use App.Authors, this is deprecated)
    Author string
    // Email of Author (Note: Use App.Authors, this is deprecated)
    Email string
    // Writer writer to write output to
    Writer io.Writer
    // ErrWriter writes error output
    ErrWriter io.Writer
    // Execute this function to handle ExitErrors. If not provided, HandleExitCoder is provided to
    // function as a default, so this is optional.
    ExitErrHandler ExitErrHandlerFunc
    // Other custom info
    Metadata map[string]interface{}
    // Carries a function which returns app specific info.
    ExtraInfo func() map[string]string
    // CustomAppHelpTemplate the text template for app help topic.
    // cli.go uses text/template to render templates. You can
    // render custom help text by setting this variable.
    CustomAppHelpTemplate string
    // 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 Uses

❖
func NewApp() *App

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

func (*App) Categories Uses

❖
func (a *App) Categories() CommandCategories

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

func (*App) Command Uses

❖
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 Uses

❖
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

Code: 

// set args for examples sake
os.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)

Code: 

// set args for examples sake
os.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 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)

Code: 

// set args for examples sake
os.Args = []string{"greet", "--generate-bash-completion"}

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
d
next
help
h
Example (CommandHelp)

Code: 

// set args for examples sake
os.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 description

USAGE:
   greet describeit [arguments...]

DESCRIPTION:
   This is how we describe describeit the function
Example (NoAction)

Code: 

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

Output:

NAME:
   greet

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

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

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version
Example (Subcommand)

Code: 

// set args for examples sake
os.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)

Code: 

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 description

USAGE:
    describeit [arguments...]

DESCRIPTION:
   This is how we describe describeit the function
Example (ZshComplete)

Code: 

// set args for examples sake
os.Args = []string{"greet", "--generate-bash-completion"}
os.Setenv("_CLI_ZSH_AUTOCOMPLETE_HACK", "1")

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

app.Run(os.Args)

Output:

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

func (*App) RunAndExitOnError Uses

❖
func (a *App) RunAndExitOnError()

RunAndExitOnError calls .Run() and exits non-zero if an error was returned

Deprecated: instead you should return an error that fulfills cli.ExitCoder to cli.App.Run. This will cause the application to exit with the given eror code in the cli.ExitCoder

func (*App) RunAsSubcommand Uses

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

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

func (*App) Setup Uses

❖
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) VisibleCategories Uses

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

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

func (*App) VisibleCommands Uses

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

VisibleCommands returns a slice of the Commands with Hidden=false

func (*App) VisibleFlags Uses

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

VisibleFlags returns a slice of the Flags with Hidden=false

type Args Uses

❖
type Args []string

Args contains apps console arguments

func (Args) First Uses

❖
func (a Args) First() string

First returns the first argument, or else a blank string

func (Args) Get Uses

❖
func (a Args) Get(n int) string

Get returns the nth argument, or else a blank string

func (Args) Present Uses

❖
func (a Args) Present() bool

Present checks if there are any arguments present

func (Args) Swap Uses

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

Swap swaps arguments at the given indexes

func (Args) Tail Uses

❖
func (a Args) Tail() []string

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

type Author Uses

❖
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 Uses

❖
func (a Author) String() string

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

type BashCompleteFunc Uses

❖
type BashCompleteFunc func(*Context)

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

type BeforeFunc Uses

❖
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 Uses

❖
type BoolFlag struct {
    Name        string
    Usage       string
    EnvVar      string
    FilePath    string
    Hidden      bool
    Destination *bool
}

BoolFlag is a flag with type bool

func (BoolFlag) Apply Uses

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

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

func (BoolFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (BoolFlag) GetName Uses

❖
func (f BoolFlag) GetName() string

GetName returns the name of the flag

func (BoolFlag) String Uses

❖
func (f BoolFlag) String() string

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

type BoolTFlag Uses

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

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

func (BoolTFlag) Apply Uses

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

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

func (BoolTFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (BoolTFlag) GetName Uses

❖
func (f BoolTFlag) GetName() string

GetName returns the name of the flag

func (BoolTFlag) String Uses

❖
func (f BoolTFlag) String() string

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

type Command Uses

❖
type Command struct {
    // The name of the command
    Name string
    // short name of the command. Typically one character (deprecated, use `Aliases`)
    ShortName string
    // A list of aliases for the command
    Aliases []string
    // A short description of the usage of this command
    Usage string
    // Custom text to show on USAGE section of help
    UsageText string
    // A longer explanation of how the command works
    Description string
    // A short description of the arguments of this command
    ArgsUsage string
    // The category the command is part of
    Category string
    // The function to call when checking for bash command completions
    BashComplete BashCompleteFunc
    // An action to execute before any sub-subcommands are run, but after the context is ready
    // If a non-nil error is returned, no sub-subcommands are run
    Before BeforeFunc
    // An action to execute after any subcommands are run, but after the subcommand has finished
    // It is run even if Action() panics
    After AfterFunc
    // The function to call when this command is invoked
    Action interface{}

    // Execute this function if a usage error occurs.
    OnUsageError OnUsageErrorFunc
    // List of child commands
    Subcommands Commands
    // List of flags to parse
    Flags []Flag
    // Treat all flags as normal arguments if true
    SkipFlagParsing bool
    // Skip argument reordering which attempts to move flags before arguments,
    // but only works if all flags appear after all arguments. This behavior was
    // removed n version 2 since it only works under specific conditions so we
    // backport here by exposing it as an option for compatibility.
    SkipArgReorder bool
    // Boolean to hide built-in help command
    HideHelp bool
    // Boolean to hide this command from help or completion
    Hidden bool
    // Boolean to enable short-option handling so user can combine several
    // single-character bool arguments into one
    // i.e. foobar -o -v -> foobar -ov
    UseShortOptionHandling bool

    // Full name of command for help, defaults to full command name, including parent commands.
    HelpName string

    // CustomHelpTemplate the text template for the command help topic.
    // cli.go uses text/template to render templates. You can
    // render custom help text by setting this variable.
    CustomHelpTemplate string
    // contains filtered or unexported fields
}

Command is a subcommand for a cli.App.

func (Command) FullName Uses

❖
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 Uses

❖
func (c Command) HasName(name string) bool

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

func (Command) Names Uses

❖
func (c Command) Names() []string

Names returns the names including short names and aliases.

func (Command) Run Uses

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

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

func (Command) VisibleFlags Uses

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

VisibleFlags returns a slice of the Flags with Hidden=false

type CommandCategories Uses

❖
type CommandCategories []*CommandCategory

CommandCategories is a slice of *CommandCategory.

func (CommandCategories) AddCommand Uses

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

AddCommand adds a command to a category.

func (CommandCategories) Len Uses

❖
func (c CommandCategories) Len() int

func (CommandCategories) Less Uses

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

func (CommandCategories) Swap Uses

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

type CommandCategory Uses

❖
type CommandCategory struct {
    Name     string
    Commands Commands
}

CommandCategory is a category containing commands.

func (*CommandCategory) VisibleCommands Uses

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

VisibleCommands returns a slice of the Commands with Hidden=false

type CommandNotFoundFunc Uses

❖
type CommandNotFoundFunc func(*Context, string)

CommandNotFoundFunc is executed if the proper command cannot be found

type Commands Uses

❖
type Commands []Command

Commands is a slice of Command

type CommandsByName Uses

❖
type CommandsByName []Command

func (CommandsByName) Len Uses

❖
func (c CommandsByName) Len() int

func (CommandsByName) Less Uses

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

func (CommandsByName) Swap Uses

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

type Context Uses

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

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

func NewContext Uses

❖
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 Uses

❖
func (c *Context) Args() Args

Args returns the command line arguments associated with the context.

func (*Context) Bool Uses

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

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

func (*Context) BoolT Uses

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

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

func (*Context) Duration Uses

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

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

func (*Context) FlagNames Uses

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

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

func (*Context) Float64 Uses

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

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

func (*Context) Generic Uses

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

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

func (*Context) GlobalBool Uses

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

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

func (*Context) GlobalBoolT Uses

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

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

func (*Context) GlobalDuration Uses

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

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

func (*Context) GlobalFlagNames Uses

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

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

func (*Context) GlobalFloat64 Uses

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

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

func (*Context) GlobalGeneric Uses

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

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

func (*Context) GlobalInt Uses

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

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

func (*Context) GlobalInt64 Uses

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

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

func (*Context) GlobalInt64Slice Uses

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

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

func (*Context) GlobalIntSlice Uses

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

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

func (*Context) GlobalIsSet Uses

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

GlobalIsSet determines if the global flag was actually set

func (*Context) GlobalSet Uses

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

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

func (*Context) GlobalString Uses

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

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

func (*Context) GlobalStringSlice Uses

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

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

func (*Context) GlobalUint Uses

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

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

func (*Context) GlobalUint64 Uses

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

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

func (*Context) Int Uses

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

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

func (*Context) Int64 Uses

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

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

func (*Context) Int64Slice Uses

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

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

func (*Context) IntSlice Uses

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

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

func (*Context) IsSet Uses

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

IsSet determines if the flag was actually set

func (*Context) NArg Uses

❖
func (c *Context) NArg() int

NArg returns the number of the command line arguments.

func (*Context) NumFlags Uses

❖
func (c *Context) NumFlags() int

NumFlags returns the number of flags set

func (*Context) Parent Uses

❖
func (c *Context) Parent() *Context

Parent returns the parent context, if any

func (*Context) Set Uses

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

Set sets a context flag to a value.

func (*Context) String Uses

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

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

func (*Context) StringSlice Uses

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

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

func (*Context) Uint Uses

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

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

func (*Context) Uint64 Uses

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

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

type DurationFlag Uses

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

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

func (DurationFlag) Apply Uses

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

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

func (DurationFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (DurationFlag) GetName Uses

❖
func (f DurationFlag) GetName() string

GetName returns the name of the flag

func (DurationFlag) String Uses

❖
func (f DurationFlag) String() string

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

type ErrorFormatter Uses

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

type ExitCoder Uses

❖
type ExitCoder interface {
    error
    ExitCode() int
}

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

type ExitErrHandlerFunc Uses

❖
type ExitErrHandlerFunc func(context *Context, err error)

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

type ExitError Uses

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

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

func NewExitError Uses

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

NewExitError makes a new *ExitError

func (*ExitError) Error Uses

❖
func (ee *ExitError) Error() string

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

func (*ExitError) ExitCode Uses

❖
func (ee *ExitError) ExitCode() int

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

type Flag Uses

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

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

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

BashCompletionFlag enables bash-completion for all commands and subcommands

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

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

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

VersionFlag prints the version for the application

type FlagEnvHintFunc Uses

❖
type FlagEnvHintFunc func(envVar, str string) string

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

❖
var FlagEnvHinter FlagEnvHintFunc = withEnvHint

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

type FlagFileHintFunc Uses

❖
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 Uses

❖
type FlagNamePrefixFunc func(fullName, placeholder string) string

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

❖
var FlagNamePrefixer FlagNamePrefixFunc = prefixedNames

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

type FlagStringFunc Uses

❖
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 Uses

❖
type FlagsByName []Flag

FlagsByName is a slice of Flag.

func (FlagsByName) Len Uses

❖
func (f FlagsByName) Len() int

func (FlagsByName) Less Uses

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

func (FlagsByName) Swap Uses

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

type Float64Flag Uses

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

Float64Flag is a flag with type float64

func (Float64Flag) Apply Uses

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

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

func (Float64Flag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (Float64Flag) GetName Uses

❖
func (f Float64Flag) GetName() string

GetName returns the name of the flag

func (Float64Flag) String Uses

❖
func (f Float64Flag) String() string

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

type Generic Uses

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

Generic is a generic parseable type identified by a specific flag

type GenericFlag Uses

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

GenericFlag is a flag with type Generic

func (GenericFlag) Apply Uses

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

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

func (GenericFlag) ApplyWithError Uses

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

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

func (GenericFlag) GetName Uses

❖
func (f GenericFlag) GetName() string

GetName returns the name of the flag

func (GenericFlag) String Uses

❖
func (f GenericFlag) String() string

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

type Int64Flag Uses

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

Int64Flag is a flag with type int64

func (Int64Flag) Apply Uses

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

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

func (Int64Flag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (Int64Flag) GetName Uses

❖
func (f Int64Flag) GetName() string

GetName returns the name of the flag

func (Int64Flag) String Uses

❖
func (f Int64Flag) String() string

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

type Int64Slice Uses

❖
type Int64Slice []int64

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

func (*Int64Slice) Get Uses

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

Get returns the slice of ints set by this flag

func (*Int64Slice) Set Uses

❖
func (f *Int64Slice) Set(value string) error

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

func (*Int64Slice) String Uses

❖
func (f *Int64Slice) String() string

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

func (*Int64Slice) Value Uses

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

Value returns the slice of ints set by this flag

type Int64SliceFlag Uses

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

Int64SliceFlag is a flag with type *Int64Slice

func (Int64SliceFlag) Apply Uses

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

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

func (Int64SliceFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (Int64SliceFlag) GetName Uses

❖
func (f Int64SliceFlag) GetName() string

GetName returns the name of the flag

func (Int64SliceFlag) String Uses

❖
func (f Int64SliceFlag) String() string

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

type IntFlag Uses

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

IntFlag is a flag with type int

func (IntFlag) Apply Uses

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

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

func (IntFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (IntFlag) GetName Uses

❖
func (f IntFlag) GetName() string

GetName returns the name of the flag

func (IntFlag) String Uses

❖
func (f IntFlag) String() string

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

type IntSlice Uses

❖
type IntSlice []int

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

func (*IntSlice) Get Uses

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

Get returns the slice of ints set by this flag

func (*IntSlice) Set Uses

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

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

func (*IntSlice) String Uses

❖
func (f *IntSlice) String() string

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

func (*IntSlice) Value Uses

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

Value returns the slice of ints set by this flag

type IntSliceFlag Uses

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

IntSliceFlag is a flag with type *IntSlice

func (IntSliceFlag) Apply Uses

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

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

func (IntSliceFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (IntSliceFlag) GetName Uses

❖
func (f IntSliceFlag) GetName() string

GetName returns the name of the flag

func (IntSliceFlag) String Uses

❖
func (f IntSliceFlag) String() string

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

type MultiError Uses

❖
type MultiError struct {
    Errors []error
}

MultiError is an error that wraps multiple errors.

func NewMultiError Uses

❖
func NewMultiError(err ...error) MultiError

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

func (MultiError) Error Uses

❖
func (m MultiError) Error() string

Error implements the error interface.

type OnUsageErrorFunc Uses

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

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

type StringFlag Uses

❖
type StringFlag struct {
    Name        string
    Usage       string
    EnvVar      string
    FilePath    string
    Hidden      bool
    Value       string
    Destination *string
}

StringFlag is a flag with type string

func (StringFlag) Apply Uses

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

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

func (StringFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (StringFlag) GetName Uses

❖
func (f StringFlag) GetName() string

GetName returns the name of the flag

func (StringFlag) String Uses

❖
func (f StringFlag) String() string

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

type StringSlice Uses

❖
type StringSlice []string

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

func (*StringSlice) Get Uses

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

Get returns the slice of strings set by this flag

func (*StringSlice) Set Uses

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

Set appends the string value to the list of values

func (*StringSlice) String Uses

❖
func (f *StringSlice) String() string

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

func (*StringSlice) Value Uses

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

Value returns the slice of strings set by this flag

type StringSliceFlag Uses

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

StringSliceFlag is a flag with type *StringSlice

func (StringSliceFlag) Apply Uses

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

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

func (StringSliceFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (StringSliceFlag) GetName Uses

❖
func (f StringSliceFlag) GetName() string

GetName returns the name of the flag

func (StringSliceFlag) String Uses

❖
func (f StringSliceFlag) String() string

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

type Uint64Flag Uses

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

Uint64Flag is a flag with type uint64

func (Uint64Flag) Apply Uses

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

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

func (Uint64Flag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (Uint64Flag) GetName Uses

❖
func (f Uint64Flag) GetName() string

GetName returns the name of the flag

func (Uint64Flag) String Uses

❖
func (f Uint64Flag) String() string

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

type UintFlag Uses

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

UintFlag is a flag with type uint

func (UintFlag) Apply Uses

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

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

func (UintFlag) ApplyWithError Uses

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

ApplyWithError populates the flag given the flag set and environment

func (UintFlag) GetName Uses

❖
func (f UintFlag) GetName() string

GetName returns the name of the flag

func (UintFlag) String Uses

❖
func (f UintFlag) String() string

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

Directories

PathSynopsis
altsrc

Package cli imports 17 packages (graph) and is imported by 2591 packages. Updated 2019-03-23. Refresh now. Tools for package owners.