cli

package module

Go to main page

Versions in this module

v1

v1.3.1

Feb 16, 2019

v1.3.0

Feb 13, 2019

Changes in this version

+ var ErrWriter io.Writer = os.Stderr

+ var OsExiter = os.Exit

+ var VersionPrinter = printVersion

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

+ func HandleExitCoder(err error)

+ type ActionFunc func(*Context) error

+ type AfterFunc func(*Context) error

type App

+ After AfterFunc

+ ArgsUsage string

+ Authors []Author

+ Copyright string

+ ErrWriter io.Writer

+ HelpName string

+ HideVersion bool

+ Metadata map[string]interface{}

+ OnUsageError OnUsageErrorFunc

+ UsageText string

+ Writer io.Writer

+ func (a *App) Categories() CommandCategories

+ func (a *App) Setup()

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

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

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

+ type Author struct

+ Email string

+ Name string

+ func (a Author) String() string

+ type BashCompleteFunc func(*Context)

+ type BeforeFunc func(*Context) error

type BoolFlag

+ Destination *bool

+ Hidden bool

+ func (f BoolFlag) GetName() string

type BoolTFlag

+ Destination *bool

+ Hidden bool

+ func (f BoolTFlag) GetName() string

type Command

+ After AfterFunc

+ Aliases []string

+ ArgsUsage string

+ Category string

+ HelpName string

+ Hidden bool

+ OnUsageError OnUsageErrorFunc

+ UsageText string

+ func (c Command) FullName() string

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

+ 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

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

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

+ 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) GlobalInt64(name string) int64

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

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

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

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

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

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

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

+ 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) Uint(name string) uint

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

+ 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

+ GetName func() string

+ type FlagStringFunc func(Flag) string

+ var FlagStringer FlagStringFunc = stringifyFlag

type Float64Flag

+ Destination *float64

+ Hidden bool

+ func (f Float64Flag) GetName() string

type GenericFlag

+ Hidden bool

+ func (f GenericFlag) GetName() string

+ type Int64Flag struct

+ Destination *int64

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value int64

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

+ func (f Int64Flag) GetName() string

+ func (f Int64Flag) String() string

+ type Int64Slice []int64

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

+ func (f *Int64Slice) String() string

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

+ type Int64SliceFlag struct

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value *Int64Slice

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

+ func (f Int64SliceFlag) GetName() string

+ func (f Int64SliceFlag) String() string

type IntFlag

+ Destination *int

+ Hidden bool

+ func (f IntFlag) GetName() string

type IntSliceFlag

+ Hidden bool

+ func (f IntSliceFlag) GetName() 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

+ Destination *string

+ Hidden bool

+ func (f StringFlag) GetName() string

type StringSliceFlag

+ Hidden bool

+ func (f StringSliceFlag) GetName() string

+ type Uint64Flag struct

+ Destination *uint64

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value uint64

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

+ func (f Uint64Flag) GetName() string

+ func (f Uint64Flag) String() string

+ type UintFlag struct

+ Destination *uint

+ EnvVar string

+ Hidden bool

+ Name string

+ Usage string

+ Value uint

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

+ func (f UintFlag) GetName() string

+ func (f UintFlag) String() string

v1.2.0

Aug 2, 2014

Changes in this version

type BoolFlag

+ EnvVar string

type BoolTFlag

+ EnvVar string

type Float64Flag

+ EnvVar string

type GenericFlag

+ EnvVar string

type IntFlag

+ EnvVar string

type IntSliceFlag

+ EnvVar string

type StringFlag

+ EnvVar string

type StringSliceFlag

+ EnvVar string

v1.1.0

Jul 15, 2014

Changes in this version

+ var BashCompletionFlag = BoolFlag

+ var HelpFlag = BoolFlag

+ var HelpPrinter = printHelp

+ var SubcommandHelpTemplate = ...

+ var VersionFlag = BoolFlag

+ func DefaultAppComplete(c *Context)

+ func ShowCommandCompletions(ctx *Context, command string)

+ func ShowCompletions(c *Context)

+ func ShowSubcommandHelp(c *Context)

type App

+ Author string

+ BashComplete func(context *Context)

+ Before func(context *Context) error

+ CommandNotFound func(context *Context, command string)

+ Compiled time.Time

+ Email string

+ EnableBashCompletion bool

+ HideHelp bool

+ func (a *App) RunAndExitOnError()

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

+ 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 BoolTFlag struct

+ Name string

+ Usage string

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

+ func (f BoolTFlag) String() string

type Command

+ BashComplete func(context *Context)

+ Before func(context *Context) error

+ HideHelp bool

+ SkipFlagParsing bool

+ Subcommands []Command

type Context

+ Command Command

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

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

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

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

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

+ type Float64Flag struct

+ Name string

+ Usage string

+ Value float64

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

+ func (f Float64Flag) String() string

+ type Generic interface

+ Set func(value string) error

+ String func() string

+ type GenericFlag struct

+ Name string

+ Usage string

+ Value Generic

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

+ func (f GenericFlag) String() string

v1.0.0

Nov 1, 2013

Changes in this version

+ var AppHelpTemplate = ...

+ var CommandHelpTemplate = ...

+ func ShowAppHelp(c *Context)

+ func ShowCommandHelp(c *Context, command string)

+ func ShowVersion(c *Context)

+ type App struct

+ Action func(context *Context)

+ Commands []Command

+ Flags []Flag

+ Name string

+ Usage string

+ Version string

+ func NewApp() *App

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

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

+ type BoolFlag struct

+ Name string

+ Usage string

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

+ func (f BoolFlag) String() string

+ type Command struct

+ Action func(context *Context)

+ Description string

+ Flags []Flag

+ Name string

+ ShortName string

+ Usage string

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

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

+ type Context struct

+ App *App

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

+ func (c *Context) Args() []string

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

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

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

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

+ 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) String(name string) string

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

+ type Flag interface

+ Apply func(*flag.FlagSet)

+ type IntFlag struct

+ Name string

+ Usage string

+ Value int

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

+ 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

+ Name string

+ Usage string

+ Value *IntSlice

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

+ func (f IntSliceFlag) String() string

+ type StringFlag struct

+ Name string

+ Usage string

+ Value string

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

+ 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

+ Name string

+ Usage string

+ Value *StringSlice

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

+ func (f StringSliceFlag) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL