Versions in this module Expand all Collapse all v2 v2.3.5 Mar 16, 2026 Changes in this version + const AlignLeft + const AlignRight + const ERR + const EvtAppAfter + const EvtAppBefore + const EvtAppError + const EvtAppInit + const EvtAppPrepareAfter + const EvtCmdAfter + const EvtCmdBefore + const EvtCmdError + const EvtCmdInit + const FlagTagName + const GOON + const HelpCommand + const HelpVarFormat + const OK + const VerbCrazy + const VerbDebug + const VerbError + const VerbInfo + const VerbQuiet + const VerbWarn + var AppHelpTemplate = ... + var CLI = &cmdLine + var CmdHelpTemplate = ... + var Version = "2.2.1" + func Logf(level uint, format string, v ...interface{}) + func Print(args ...interface{}) + func Printf(format string, args ...interface{}) + func Println(args ...interface{}) + func SetDebugMode() + func SetQuietMode() + func SetStrictMode(strict bool) + func SetVerbose(verbose uint) + func StrictMode() bool + func Verbose() uint + type App struct + Args []string + Description string + ExitFunc func(int) + ExitOnEnd bool + Logo Logo + Name string + Version string + func InitStdApp(fn ...func(a *App)) *App + func NewApp(fn ...func(a *App)) *App + func StdApp() *App + func (app *App) Add(c *Command, more ...*Command) + func (app *App) AddAliases(command string, aliases ...string) + func (app *App) AddCommand(c *Command) *Command + func (app *App) AddCommander(cmder Commander) *Command + func (app *App) AddError(err error) + func (app *App) CleanArgs() []string + func (app *App) CommandName() string + func (app *App) CommandNames() []string + func (app *App) Commands() map[string]*Command + func (app *App) Config(fn func(a *App)) + func (app *App) DefaultCommand(name string) + func (app *App) Exec(name string, args []string) (err error) + func (app *App) Exit(code int) + func (app *App) HasCommand(name string) bool + func (app *App) IsAlias(str string) bool + func (app *App) IsCommand(name string) bool + func (app *App) Names() map[string]int + func (app *App) NewCommand(name, useFor string, config func(c *Command)) *Command + func (app *App) On(name string, handler HookFunc) + func (app *App) RealCommandName(alias string) string + func (app *App) RemoveCommand(names ...string) int + func (app *App) ResolveName(alias string) string + func (app *App) Run() (code int) + func (app *App) SetDebugMode() + func (app *App) SetLogo(logo string, style ...string) + func (app *App) SetQuietMode() + func (app *App) SetVerbose(verbose uint) + func (c App) GlobalFlags() *Flags + type Argument struct + Desc string + Handler func(val interface{}) interface{} + IsArray bool + Name string + Required bool + ShowName string + Validator func(val interface{}) (interface{}, error) + Value interface{} + func NewArgument(name, desc string, requiredAndIsArray ...bool) *Argument + func (a *Argument) Array() (ss []string) + func (a *Argument) GetValue() interface{} + func (a *Argument) HasValue() bool + func (a *Argument) HelpName() string + func (a *Argument) Index() int + func (a *Argument) Int(defVal ...int) int + func (a *Argument) IsEmpty() bool + func (a *Argument) SetValue(val interface{}) error + func (a *Argument) String(defVal ...string) string + func (a *Argument) StringSplit(sep ...string) (ss []string) + func (a *Argument) Strings() (ss []string) + func (a *Argument) WithConfig(fn func(arg *Argument)) *Argument + func (a *Argument) WithValidator(fn func(interface{}) (interface{}, error)) *Argument + type Arguments struct + func (ags *Arguments) Add(arg Argument) *Argument + func (ags *Arguments) AddArg(name, desc string, requiredAndIsArray ...bool) *Argument + func (ags *Arguments) AddArgument(arg *Argument) *Argument + func (ags *Arguments) Arg(name string) *Argument + func (ags *Arguments) ArgByIndex(i int) *Argument + func (ags *Arguments) Args() []*Argument + func (ags *Arguments) BindArg(arg Argument) *Argument + func (ags *Arguments) HasArg(name string) bool + func (ags *Arguments) ParseArgs(args []string) (err error) + func (ags *Arguments) SetName(name string) + func (ags *Arguments) SetValidateNum(validateNum bool) + type Booleans []bool + func (s *Booleans) Set(value string) error + func (s *Booleans) String() string + type CmdFunc func(c *Command, args []string) error + func (f CmdFunc) Run(c *Command, args []string) error + type Command struct + Aliases []string + Config func(c *Command) + CustomFlags bool + Examples string + Func CmdFunc + Help string + HelpRender func(c *Command) + Name string + UseFor string + func NewCommand(name, useFor string, fn ...func(c *Command)) *Command + func (c *Command) AliasesString(sep ...string) string + func (c *Command) App() *App + func (c *Command) AttachTo(app *App) + func (c *Command) Copy() *Command + func (c *Command) Disable() + func (c *Command) Errorf(format string, v ...interface{}) error + func (c *Command) Fire(event string, data interface{}) + func (c *Command) IsAlone() bool + func (c *Command) IsDisabled() bool + func (c *Command) Logf(level uint, format string, v ...interface{}) + func (c *Command) Module() string + func (c *Command) MustRun(inArgs []string) + func (c *Command) NotAlone() bool + func (c *Command) On(name string, handler HookFunc) + func (c *Command) Run(inArgs []string) (err error) + func (c *Command) Runnable() bool + func (c *Command) SetFunc(fn CmdFunc) *Command + func (c *Command) ShowHelp() + func (c *Command) SubName() string + func (c Command) GlobalFlags() *Flags + type Commander interface + Creator func() *Command + Prepare func(c *Command) + Run func(c *Command, args []string) error + type Executor interface + type FlagMeta struct + DefVal interface{} + Desc string + Hidden bool + Name string + Required bool + Shorts []string + Validator func(val string) error + func (m *FlagMeta) DValue() *goutil.Value + func (m *FlagMeta) Shorts2String(sep ...string) string + func (m *FlagMeta) Validate(val string) error + type Flags struct + func NewFlags(name ...string) *Flags + func (fs *Flags) BoolOpt(p *bool, name, shorts string, defValue bool, desc string) + func (fs *Flags) BoolVar(p *bool, meta FlagMeta) + func (fs *Flags) FSet() *flag.FlagSet + func (fs *Flags) FlagMeta(name string) *FlagMeta + func (fs *Flags) FlagNames() map[string]int + func (fs *Flags) Float64Opt(p *float64, name, shorts string, defValue float64, desc string) + func (fs *Flags) Float64Var(p *float64, meta FlagMeta) + func (fs *Flags) FromStruct(ptr interface{}) error + func (fs *Flags) HasFlag(name string) bool + func (fs *Flags) HasFlagMeta(name string) bool + func (fs *Flags) HasOption(name string) bool + func (fs *Flags) InitFlagSet(name string) + func (fs *Flags) Int64Opt(p *int64, name, shorts string, defValue int64, desc string) + func (fs *Flags) Int64Var(p *int64, meta FlagMeta) + func (fs *Flags) IntOpt(p *int, name, shorts string, defValue int, desc string) + func (fs *Flags) IntVar(p *int, meta FlagMeta) + func (fs *Flags) IsOption(name string) bool + func (fs *Flags) IsShortName(short string) bool + func (fs *Flags) IsShortOpt(short string) bool + func (fs *Flags) IterAll(fn func(f *flag.Flag, meta *FlagMeta)) + func (fs *Flags) Len() int + func (fs *Flags) LookupFlag(name string) *flag.Flag + func (fs *Flags) Metas() map[string]*FlagMeta + func (fs *Flags) Name() string + func (fs *Flags) Parse(args []string) (err error) + func (fs *Flags) PrintHelpPanel() + func (fs *Flags) RawArg(i int) string + func (fs *Flags) RawArgs() []string + func (fs *Flags) SetFlagSet(fSet *flag.FlagSet) + func (fs *Flags) SetOutput(out io.Writer) + func (fs *Flags) ShortNames(name string) (ss []string) + func (fs *Flags) StrOpt(p *string, name, shorts, defValue, desc string) + func (fs *Flags) StrVar(p *string, meta FlagMeta) + func (fs *Flags) String() string + func (fs *Flags) Uint64Opt(p *uint64, name, shorts string, defValue uint64, desc string) + func (fs *Flags) Uint64Var(p *uint64, meta FlagMeta) + func (fs *Flags) UintOpt(p *uint, name, shorts string, defValue uint, desc string) + func (fs *Flags) UintVar(p *uint, meta FlagMeta) + func (fs *Flags) Var(p flag.Value, meta FlagMeta) + func (fs *Flags) VarOpt(p flag.Value, name, shorts, desc string) + func (fs *Flags) WithOption(cfg FlagsOption) *Flags + type FlagsOption struct + Alignment strutil.PosFlag + NameDescOL bool + TagName string + WithoutType bool + type GlobalOpts struct + NoColor bool + func GOpts() *GlobalOpts + type HelpVars struct + Vars map[string]string + func (hv *HelpVars) AddVar(name, value string) + func (hv *HelpVars) AddVars(vars map[string]string) + func (hv *HelpVars) GetVar(name string) string + func (hv *HelpVars) GetVars() map[string]string + func (hv *HelpVars) ReplaceVars(input string) string + type HookFunc func(obj ...interface{}) + type Hooks struct + func (h *Hooks) AddOn(name string, handler HookFunc) + func (h *Hooks) ClearHooks() + func (h *Hooks) Fire(event string, data ...interface{}) + func (h *Hooks) On(name string, handler HookFunc) + type Ints []int + func (s *Ints) Set(value string) error + func (s *Ints) String() string + type Logo struct + Style string + Text string + type Runner interface + Run func(c *Command, args []string) error + type RunningAble struct + type Strings []string + func (s *Strings) Set(value string) error + func (s *Strings) String() string
Go to main page