cli

package module

Go to main page

Versions in this module

v0

v0.2.0

May 29, 2019

Changes in this version

+ var ErrWriter io.Writer = os.Stderr

+ var HelpPrinterCustom helpPrinterCustom = printHelpCustom

+ var OsExiter = os.Exit

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

+ func HandleExitCoder(err error)

+ func ShowAppHelpAndExit(c *Context, exitCode int)

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

+ type ActionFunc func(*Context) error

+ type AfterFunc func(*Context) error

type App

+ CustomAppHelpTemplate string

+ Description string

+ ErrWriter io.Writer

+ ExtraInfo func() map[string]string

+ Metadata map[string]interface{}

+ func (a *App) Setup()

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

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

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

+ type BashCompleteFunc func(*Context)

+ type BeforeFunc func(*Context) error

type BoolFlag

+ Hidden bool

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

type BoolTFlag

+ Hidden bool

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

type Command

+ CustomHelpTemplate string

+ Hidden bool

+ SkipArgReorder bool

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

type CommandCategory

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

+ type CommandNotFoundFunc func(*Context, string)

+ type CommandsByName []Command

+ func (c CommandsByName) Len() int

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

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

type Context

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

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

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

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

+ 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) Set(name, value string) error

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

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

type DurationFlag

+ Hidden bool

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

+ type ErrorFormatter interface

+ Format func(s fmt.State, verb rune)

+ type ExitCoder interface

+ ExitCode func() int

+ type ExitError struct

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

+ func (ee *ExitError) Error() string

+ func (ee *ExitError) ExitCode() int

+ type FlagStringFunc func(Flag) string

+ var FlagStringer FlagStringFunc = stringifyFlag

+ type FlagsByName []Flag

+ func (f FlagsByName) Len() int

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

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

type Float64Flag

+ Hidden bool

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

type GenericFlag

+ Hidden bool

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

+ 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) ApplyWithError(set *flag.FlagSet) error

+ func (f Int64Flag) GetName() string

+ func (f Int64Flag) String() string

+ type Int64Slice []int64

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

+ 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) ApplyWithError(set *flag.FlagSet) error

+ func (f Int64SliceFlag) GetName() string

+ func (f Int64SliceFlag) String() string

type IntFlag

+ Hidden bool

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

type IntSlice

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

type IntSliceFlag

+ Hidden bool

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

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

type StringFlag

+ Hidden bool

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

type StringSlice

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

type StringSliceFlag

+ Hidden bool

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

+ 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) ApplyWithError(set *flag.FlagSet) error

+ 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) ApplyWithError(set *flag.FlagSet) error

+ func (f UintFlag) GetName() string

+ func (f UintFlag) String() string

v0.1.0

Jan 30, 2019

Changes in this version

+ var AppHelpTemplate = ...

+ var BashCompletionFlag = BoolFlag

+ var CommandHelpTemplate = ...

+ var HelpFlag = BoolFlag

+ var HelpPrinter helpPrinter = printHelp

+ var SubcommandHelpTemplate = ...

+ var VersionFlag = BoolFlag

+ var VersionPrinter = printVersion

+ func DefaultAppComplete(c *Context)

+ func ShowAppHelp(c *Context)

+ func ShowCommandCompletions(ctx *Context, command string)

+ func ShowCommandHelp(ctx *Context, command string)

+ func ShowCompletions(c *Context)

+ func ShowSubcommandHelp(c *Context)

+ func ShowVersion(c *Context)

+ type App struct

+ Action func(context *Context)

+ After func(context *Context) error

+ ArgsUsage string

+ Author string

+ Authors []Author

+ BashComplete func(context *Context)

+ Before func(context *Context) error

+ CommandNotFound func(context *Context, command string)

+ Commands []Command

+ Compiled time.Time

+ Copyright string

+ Email string

+ EnableBashCompletion bool

+ Flags []Flag

+ HelpName string

+ HideHelp bool

+ HideVersion bool

+ Name string

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

+ 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)

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

+ Destination *bool

+ EnvVar string

+ 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

+ 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 func(context *Context)

+ After func(context *Context) error

+ Aliases []string

+ ArgsUsage string

+ BashComplete func(context *Context)

+ Before func(context *Context) error

+ Category string

+ Description string

+ Flags []Flag

+ HelpName string

+ HideHelp bool

+ Name string

+ OnUsageError func(context *Context, err error) error

+ 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)

+ 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

+ 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) GlobalDuration(name string) time.Duration

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

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

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

+ type DurationFlag struct

+ Destination *time.Duration

+ EnvVar string

+ 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 Flag interface

+ Apply func(*flag.FlagSet)

+ GetName func() string

+ type Float64Flag struct

+ Destination *float64

+ EnvVar string

+ 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

+ Name string

+ Usage string

+ Value Generic

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

+ func (f GenericFlag) FormatValueHelp() string

+ func (f GenericFlag) GetName() string

+ func (f GenericFlag) String() string

+ type IntFlag struct

+ Destination *int

+ EnvVar string

+ 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

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

+ Destination *string

+ EnvVar string

+ Name string

+ Usage string

+ Value string

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

+ func (f StringFlag) FormatValueHelp() string

+ 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

+ Name string

+ Usage string

+ Value *StringSlice

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

+ func (f StringSliceFlag) GetName() string

+ func (f StringSliceFlag) String() string

Other modules containing this package

github.com/micro/cli/v2

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