gcli

package module

Go to main page

Versions in this module

v2

v2.3.4

Sep 16, 2020

Changes in this version

+ const FlagTagName

type FlagMeta

+ Validator func(val string) error

+ func (m *FlagMeta) Validate(val string) error

type FlagsOption

+ TagName string

v2.3.3

Aug 3, 2020

Changes in this version

+ var AppHelpTemplate = ...

+ var CmdHelpTemplate = ...

type Command

+ HelpRender func(c *Command)

type GlobalOpts

+ NoColor bool

+ func GOpts() *GlobalOpts

v2.3.2

Aug 1, 2020

Changes in this version

type Argument

+ func (a *Argument) SetValue(val interface{}) error

+ func (a *Argument) WithConfig(fn func(arg *Argument)) *Argument

type Arguments

+ func (ags *Arguments) HasArg(name string) bool

type Command

+ func (c *Command) SubName() string

type FlagMeta

+ func (m *FlagMeta) Shorts2String(sep ...string) string

type Flags

+ func (fs *Flags) HasFlag(name string) bool

+ func (fs *Flags) IsOption(name string) bool

+ func (fs *Flags) Len() int

v2.3.1

Jul 30, 2020

v2.3.0

Jul 30, 2020

Changes in this version

+ const AlignLeft

+ const AlignRight

+ const EvtAppAfter

+ const EvtAppBefore

+ const EvtAppError

+ const EvtAppInit

+ const EvtAppPrepareAfter

+ const EvtCmdAfter

+ const EvtCmdBefore

+ const EvtCmdError

+ const EvtCmdInit

type App

+ ExitFunc func(int)

+ func (app *App) AddCommander(cmder Commander) *Command

+ func (app *App) Exit(code int)

+ func (app *App) HasCommand(name string) bool

+ func (app *App) IsAlias(str string) bool

+ func (app *App) RemoveCommand(names ...string) int

+ func (app *App) ResolveName(alias string) string

+ func (c App) GlobalFlags() *Flags

type Argument

+ Desc string

+ func (a *Argument) HelpName() string

+ 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) ParseArgs(args []string) (err error)

+ func (ags *Arguments) SetName(name string)

+ func (ags *Arguments) SetValidateNum(validateNum bool)

type Command

+ 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

+ func (m *FlagMeta) DValue() *goutil.Value

+ func (m *FlagMeta) Description() string

+ 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) 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) 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) LookupFlag(name string) *flag.Flag

+ func (fs *Flags) Metas() map[string]*FlagMeta

+ func (fs *Flags) Name() string

+ func (fs *Flags) Parse(args []string) 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 uint8

+ NameDescOL bool

+ WithoutType bool

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

v2.2.1

Apr 26, 2020

Changes in this version

+ var Version = "2.2.1"

v2.2.0

Apr 26, 2020

v2.1.1

Apr 13, 2020

Changes in this version

type Argument

+ Validator func(val interface{}) (interface{}, error)

+ func (a *Argument) Config(fn func(arg *Argument))

+ func (a *Argument) WithValidator(fn func(interface{}) (interface{}, error)) *Argument

+ func (a *Argument) WithValue(val interface{}) *Argument

v2.1.0

Sep 8, 2019

Changes in this version

+ const GOON

type App

+ Args []string

+ ExitOnEnd bool

type Argument

+ Handler func(value interface{}) interface{}

+ func NewArgument(name, description string, requiredAndIsArray ...bool) *Argument

+ func (a *Argument) GetValue() interface{}

+ func (a *Argument) Index() int

+ func (a *Argument) IsEmpty() bool

+ func (a *Argument) StringSplit(sep ...string) (ss []string)

type Command

+ func (c *Command) AddArgument(arg *Argument) *Argument

type SimpleHooks

+ func (sh *SimpleHooks) AddOn(name string, handler HookFunc)

v2.0.10

Sep 1, 2019

Changes in this version

+ func StrictMode() bool

v2.0.9

Aug 3, 2019

Changes in this version

+ func SetStrictMode(strict bool)

type App

+ func InitStdApp(fn ...func(a *App)) *App

+ func StdApp() *App

v2.0.8

May 24, 2019

v2.0.7

May 23, 2019

Changes in this version

+ const ERR

+ const EvtAfter

+ const EvtBefore

+ const EvtError

+ const EvtInit

+ const HelpCommand

+ const HelpVarFormat

+ const OK

+ const VerbCrazy

+ const VerbDebug

+ const VerbError

+ const VerbInfo

+ const VerbQuiet

+ const VerbWarn

+ func AllCommands() map[string]*Command

+ func Exit(code int)

+ 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 SetVerbose(verbose uint)

+ func Verbose() uint

+ type App struct

+ Description string

+ Logo Logo

+ Name string

+ Strict bool

+ Version string

+ var CLI = &CmdLine{ ... }

+ var DefaultApp *App

+ func NewApp(fn ...func(a *App)) *App

+ func NewDefaultApp(fn ...func(a *App)) *App

+ func (app *App) Add(c *Command, more ...*Command)

+ func (app *App) AddAliases(command string, names []string)

+ func (app *App) AddCommand(c *Command) *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) Initialize()

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

+ func (app *App) SetDebugMode()

+ func (app *App) SetLogo(logo string, style ...string)

+ func (app *App) SetQuietMode()

+ func (app *App) SetVerbose(verbose uint)

+ type Argument struct

+ Description string

+ IsArray bool

+ Name string

+ Required bool

+ ShowName string

+ Value interface{}

+ func (a *Argument) Array() (ss []string)

+ func (a *Argument) HasValue() bool

+ func (a *Argument) Int(defVal ...int) int

+ func (a *Argument) String(defVal ...string) string

+ func (a *Argument) Strings() (ss []string)

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

+ func (c *CmdLine) ArgLine() string

+ func (c *CmdLine) BinName() string

+ func (c *CmdLine) OsArgs() []string

+ func (c *CmdLine) OsName() string

+ func (c *CmdLine) PID() int

+ func (c *CmdLine) WorkDir() string

+ type Command struct

+ Aliases []string

+ Config func(c *Command)

+ CustomFlags bool

+ Examples string

+ Flags flag.FlagSet

+ Func CmdFunc

+ Help string

+ Hooks map[string]HookFunc

+ Module string

+ Name string

+ UseFor string

+ func NewCommand(name, useFor string, config func(c *Command)) *Command

+ func (c *Command) AddArg(name, description string, requiredAndIsArray ...bool) *Argument

+ func (c *Command) AliasesString(sep ...string) string

+ func (c *Command) App() *App

+ func (c *Command) Arg(name string) *Argument

+ func (c *Command) ArgByIndex(i int) *Argument

+ func (c *Command) Args() []*Argument

+ func (c *Command) AttachTo(app *App)

+ func (c *Command) BoolOpt(p *bool, name string, short string, defValue bool, description string) *Command

+ func (c *Command) Copy() *Command

+ func (c *Command) Disable()

+ func (c *Command) Errorf(format string, v ...interface{}) error

+ func (c *Command) Execute(args []string) (err error)

+ func (c *Command) Fire(event string, data interface{})

+ func (c *Command) ID() string

+ func (c *Command) IntOpt(p *int, name string, short string, defValue int, description string) *Command

+ func (c *Command) IsAlone() bool

+ func (c *Command) IsDisabled() bool

+ func (c *Command) Logf(level uint, format string, v ...interface{})

+ func (c *Command) MustRun(inArgs []string)

+ func (c *Command) NotAlone() bool

+ func (c *Command) On(name string, handler HookFunc)

+ func (c *Command) OptDes(name string) string

+ func (c *Command) OptFlag(name string) *flag.Flag

+ func (c *Command) OptNames() map[string]string

+ func (c *Command) ParseDefaults() string

+ func (c *Command) RawArg(i int) string

+ func (c *Command) RawArgs() []string

+ func (c *Command) Run(inArgs []string) error

+ func (c *Command) Runnable() bool

+ func (c *Command) SetFunc(fn CmdFunc) *Command

+ func (c *Command) ShortName(name string) string

+ func (c *Command) ShowHelp(quit ...bool)

+ func (c *Command) StrOpt(p *string, name string, short string, defValue string, description string) *Command

+ func (c *Command) UintOpt(p *uint, name string, short string, defValue uint, description string) *Command

+ func (c *Command) VarOpt(p flag.Value, name string, short string, description string) *Command

+ type GlobalOpts struct

+ 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 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(cmd *Command, args []string) error

+ type SimpleHooks struct

+ func (sh *SimpleHooks) Add(name string, handler HookFunc)

+ func (sh *SimpleHooks) ClearHooks()

+ func (sh *SimpleHooks) Fire(event string, data ...interface{})

+ func (sh *SimpleHooks) On(name string, handler HookFunc)

+ type Strings []string

+ func (s *Strings) Set(value string) error

+ func (s *Strings) String() string

Other modules containing this package

github.com/gookit/gcli

github.com/gookit/gcli/v3

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