Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cli

package

Go to main page

Versions in this module

v1

v1.4.18

Oct 15, 2016

v1.4.16

Oct 6, 2016

v1.4.15

Oct 3, 2016

v1.4.14

Sep 28, 2016

v1.4.12

Sep 19, 2016

v1.4.11

Aug 18, 2016

v1.4.10

Jul 16, 2016

Changes in this version

+ var AppHelpTemplate = ...

+ var BashCompletionFlag = BoolFlag

+ var CommandHelpTemplate = ...

+ var ErrWriter io.Writer = os.Stderr

+ var HelpFlag = BoolFlag

+ var HelpPrinter helpPrinter = printHelp

+ var OsExiter = os.Exit

+ var SubcommandHelpTemplate = ...

+ var VersionFlag = BoolFlag

+ var VersionPrinter = printVersion

+ func DefaultAppComplete(c *Context)

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

+ func HandleExitCoder(err error)

+ func ShowAppHelp(c *Context)

+ func ShowCommandCompletions(ctx *Context, command string)

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

+ func ShowCompletions(c *Context)

+ func ShowSubcommandHelp(c *Context) error

+ func ShowVersion(c *Context)

+ type ActionFunc func(*Context) error

+ type AfterFunc func(*Context) error

+ type App struct

+ Action interface{}

+ After AfterFunc

+ ArgsUsage string

+ Author string

+ Authors []Author

+ BashComplete BashCompleteFunc

+ Before BeforeFunc

+ CommandNotFound CommandNotFoundFunc

+ Commands []Command

+ Compiled time.Time

+ Copyright string

+ Email string

+ EnableBashCompletion bool

+ ErrWriter io.Writer

+ Flags []Flag

+ HelpName string

+ HideHelp bool

+ HideVersion bool

+ Metadata map[string]interface{}

+ Name string

+ OnUsageError OnUsageErrorFunc

+ Usage string

+ UsageText string

+ Version string

+ Writer io.Writer

+ func NewApp() *App

+ func (a *App) Categories() CommandCategories

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

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

+ func (a *App) RunAndExitOnError()

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

+ func (a *App) Setup()

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

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

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

+ type Args []string

+ func (a Args) First() string

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

+ func (a Args) Present() bool

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

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

+ type Author struct

+ Email string

+ Name string

+ func (a Author) String() string

+ type BashCompleteFunc func(*Context)

+ type BeforeFunc func(*Context) error

+ type BoolFlag struct

+ Destination *bool

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

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

+ func (f BoolFlag) GetName() string

+ func (f BoolFlag) String() string

+ type BoolTFlag struct

+ Destination *bool

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

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

+ func (f BoolTFlag) GetName() string

+ func (f BoolTFlag) String() string

+ type Command struct

+ Action interface{}

+ After AfterFunc

+ Aliases []string

+ ArgsUsage string

+ BashComplete BashCompleteFunc

+ Before BeforeFunc

+ Category string

+ Description string

+ Flags []Flag

+ HelpName string

+ Hidden bool

+ HideHelp bool

+ Name string

+ OnUsageError OnUsageErrorFunc

+ ShortName string

+ SkipFlagParsing bool

+ Subcommands Commands

+ Usage string

+ UsageText string

+ func (c Command) FullName() string

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

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

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

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

+ type CommandCategories []*CommandCategory

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

+ func (c CommandCategories) Len() int

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

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

+ type CommandCategory struct

+ Commands Commands

+ Name string

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

+ type CommandNotFoundFunc func(*Context, string)

+ type Commands []Command

+ type Context struct

+ App *App

+ Command Command

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

+ func (c *Context) Args() Args

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+ func (c *Context) NArg() int

+ func (c *Context) NumFlags() int

+ func (c *Context) Parent() *Context

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

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

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

+ type DurationFlag struct

+ Destination *time.Duration

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value time.Duration

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

+ func (f DurationFlag) GetName() string

+ func (f DurationFlag) String() string

+ type ExitCoder interface

+ ExitCode func() int

+ type ExitError struct

+ func NewExitError(message string, exitCode int) *ExitError

+ func (ee *ExitError) Error() string

+ func (ee *ExitError) ExitCode() int

+ type Flag interface

+ Apply func(*flag.FlagSet)

+ GetName func() string

+ type FlagStringFunc func(Flag) string

+ var FlagStringer FlagStringFunc = stringifyFlag

+ type Float64Flag struct

+ Destination *float64

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value float64

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

+ func (f Float64Flag) GetName() string

+ func (f Float64Flag) String() string

+ type Generic interface

+ Set func(value string) error

+ String func() string

+ type GenericFlag struct

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value Generic

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

+ func (f GenericFlag) GetName() string

+ func (f GenericFlag) String() string

+ type IntFlag struct

+ Destination *int

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value int

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

+ func (f IntFlag) GetName() string

+ func (f IntFlag) String() string

+ type IntSlice []int

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

+ func (f *IntSlice) String() string

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

+ type IntSliceFlag struct

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value *IntSlice

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

+ func (f IntSliceFlag) GetName() string

+ func (f IntSliceFlag) String() string

+ type MultiError struct

+ Errors []error

+ func NewMultiError(err ...error) MultiError

+ func (m MultiError) Error() string

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

+ type StringFlag struct

+ Destination *string

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value string

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

+ func (f StringFlag) GetName() string

+ func (f StringFlag) String() string

+ type StringSlice []string

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

+ func (f *StringSlice) String() string

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

+ type StringSliceFlag struct

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value *StringSlice

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

+ func (f StringSliceFlag) GetName() string

+ func (f StringSliceFlag) String() string