gcli

package module

Go to main page

Versions in this module

v3

v3.2.4

Dec 12, 2024

Changes in this version

type App

+ func (app *App) RunArgs(args ...string) int

v3.2.3

Jul 27, 2023

v3.2.2

Jun 25, 2023

Changes in this version

type App

+ func (b *App) ChWorkDir(dir string)

type Command

+ func (b *Command) ChWorkDir(dir string)

type Context

+ func (ctx *Context) ChWorkDir(dir string)

v3.2.1

Feb 26, 2023

Changes in this version

+ type ConfString = cflag.ConfString

+ type KVString = cflag.KVString

v3.2.0

Feb 11, 2023

v3.1.1

Dec 22, 2022

Changes in this version

type App

+ func (b *App) AddHelpVar(key string, val any)

+ func (b *App) BinDir() string

+ func (b *App) BinName() string

+ func (b *App) WorkDir() string

type Command

+ func (b *Command) AddHelpVar(key string, val any)

+ func (b *Command) BinDir() string

+ func (b *Command) BinName() string

+ func (b *Command) WorkDir() string

+ func (c *Command) IsRunnable() bool

+ type HelpReplacer struct

+ VarClose string

+ VarOpen string

+ func (hv *HelpReplacer) AddReplace(name, value string)

+ func (hv *HelpReplacer) AddReplaces(vars map[string]string)

+ func (hv *HelpReplacer) GetReplace(name string) string

+ func (hv *HelpReplacer) ReplacePairs(input string) string

+ func (hv *HelpReplacer) Replaces() map[string]string

v3.1.0

Oct 16, 2022

Changes in this version

+ func Config(fn func(opts *GlobalOpts))

type App

+ func (app *App) Flags() *Flags

+ func (app *App) Opts() *GlobalOpts

+ func (app *App) QuickRun() int

+ func (b *App) AddTplVar(key string, val any)

+ func (b *App) ResetData()

+ type AppConfig struct

+ AfterAddOpts func(app *App) bool

+ AfterRun func() bool

+ BeforeAddOpts func(opts *Flags)

+ BeforeRun func() bool

+ type CliArg = gflag.CliArg

+ type CliArgs = gflag.CliArgs

+ type CliOpt = gflag.CliOpt

type Command

+ func (b *Command) AddTplVar(key string, val any)

+ func (b *Command) HasSubcommands() bool

+ func (b *Command) ResetData()

+ type Context struct

+ func GCtx() *Context

+ func NewCtx() *Context

+ func (ctx *Context) ArgLine() string

+ func (ctx *Context) BinDir() string

+ func (ctx *Context) BinFile() string

+ func (ctx *Context) BinName() string

+ func (ctx *Context) GetVal(key string) interface{}

+ func (ctx *Context) InitCtx() *Context

+ func (ctx *Context) OsArgs() []string

+ func (ctx *Context) OsName() string

+ func (ctx *Context) PID() int

+ func (ctx *Context) PIDString() string

+ func (ctx *Context) ResetData()

+ func (ctx *Context) SetValue(key string, val any)

+ func (ctx *Context) Value(key any) any

+ func (ctx *Context) WorkDir() string

+ type GlobalOpts struct

+ Disable bool

+ NoColor bool

+ NoInteractive bool

+ NoProgress bool

+ ShowHelp bool

+ ShowVersion bool

+ Verbose VerbLevel

+ func (g *GlobalOpts) SetDisable()

+ func (g *GlobalOpts) SetStrictMode(strictMode bool)

+ func (g *GlobalOpts) SetVerbose(verbose VerbLevel)

type HookCtx

+ func (hc *HookCtx) Err() error

+ func (hc *HookCtx) SetStop(stop bool) bool

+ func (hc *HookCtx) Stopped() bool

+ func (hc *HookCtx) WithApp(a *App) *HookCtx

+ func (hc *HookCtx) WithData(data map[string]any) *HookCtx

+ func (hc *HookCtx) WithErr(err error) *HookCtx

type Hooks

+ func (h *Hooks) AddHook(name string, handler HookFunc)

+ func (h *Hooks) ResetHooks()

v3.0.6

Sep 1, 2022

v3.0.5

Aug 13, 2022

Changes in this version

+ const VerbEnvName

type FlagMeta

+ EnvVar string

type GOptions

+ Disable bool

+ func (g *GOptions) SetDisable()

v3.0.4

Jul 18, 2022

v3.0.3

Jul 12, 2022

Changes in this version

type Argument

+ func NewArg(name, desc string, val any, requiredAndArrayed ...bool) *Argument

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

+ func (a *Argument) WithValue(val any) *Argument

type FlagMeta

+ Flag *flag.Flag

+ func (m *FlagMeta) HelpName() string

type Flags

+ func (fs *Flags) BuildHelp() string

+ func (fs *Flags) SetConfig(opt *FlagsConfig)

+ func (fs *Flags) WithConfigFn(fns ...func(cfg *FlagsConfig)) *Flags

+ type FlagsConfig struct

+ Alignment uint8

+ DescNewline bool

+ TagName string

+ TagRuleType uint8

+ WithoutType bool

+ type OptCategory struct

+ Name string

+ OptNames []string

+ Title string

v3.0.2

Jul 4, 2022

Changes in this version

type Flags

+ func (fs *Flags) UseSimpleRule() *Flags

type HookCtx

+ func (md *HookCtx) GetVal(key string) interface{}

v3.0.1

Oct 11, 2021

Changes in this version

+ const TagRuleNamed

+ const TagRuleSimple

+ func IsDebugMode() bool

type App

+ func (app *App) RunCmd(name string, args []string) int

type Argument

+ Arrayed bool

+ func (a *Argument) SetArrayed() *Argument

type Arguments

+ func (ags *Arguments) AddArgByRule(name, rule string) *Argument

type Command

+ Hidden bool

+ func (c *Command) NewErr(msg string) error

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

+ func (c *Command) Visible() bool

+ func (c *Command) WithHidden() *Command

type EnumString

+ func (s *EnumString) SetEnum(enum []string)

type FlagsOption

+ TagRuleType uint8

+ type String string

+ func (s *String) Set(val string) error

+ func (s String) Ints(sep string) []int

+ func (s String) Split(sep string) []string

+ func (s String) String() string

v3.0.0

Apr 15, 2021

Changes in this version

+ const AlignLeft

+ const AlignRight

+ const CommandSep

+ const ERR

+ const EvtAppCmdNotFound

+ const EvtAppInit

+ const EvtAppPrepareAfter

+ const EvtAppRunAfter

+ const EvtAppRunBefore

+ const EvtAppRunError

+ const EvtCmdExecAfter

+ const EvtCmdExecBefore

+ const EvtCmdExecError

+ const EvtCmdInit

+ const EvtCmdNotFound

+ const EvtCmdOptParsed

+ const EvtCmdRunAfter

+ const EvtCmdRunBefore

+ const EvtCmdRunError

+ const EvtCmdSubNotFound

+ const EvtGOptionsParsed

+ const GOON

+ const HelpCommand

+ const HelpVarFormat

+ const OK

+ var AppHelpTemplate = ...

+ var CLI = newCmdLine()

+ var CmdHelpTemplate = ...

+ var DefaultVerb = VerbError

+ var FlagTagName = "flag"

+ func CommitID() string

+ func Debugf(format string, v ...interface{})

+ func IsGteVerbose(verb VerbLevel) bool

+ func Logf(level VerbLevel, format string, v ...interface{})

+ func NotExitOnEnd() func(*App)

+ func Print(args ...interface{})

+ func Printf(format string, args ...interface{})

+ func Println(args ...interface{})

+ func ResetGOpts()

+ func ResetVerbose()

+ func SetCrazyMode()

+ func SetDebugMode()

+ func SetQuietMode()

+ func SetStrictMode(strict bool)

+ func SetVerbose(verbose VerbLevel)

+ func StrictMode() bool

+ func Version() string

+ type App struct

+ Desc string

+ ExitFunc func(int)

+ ExitOnEnd bool

+ Func func(app *App, args []string) error

+ Name string

+ func New(fns ...func(app *App)) *App

+ func NewApp(fns ...func(app *App)) *App

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

+ func (app *App) AddAliases(name string, aliases ...string)

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

+ func (app *App) AddHandler(h Handler)

+ func (app *App) CommandName() string

+ func (app *App) Config(fn func(a *App))

+ func (app *App) Exec(path string, args []string) error

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

+ func (app *App) Fire(event string, data interface{}) bool

+ func (app *App) HasSubcommands() bool

+ func (app *App) On(name string, handler HookFunc)

+ func (app *App) Run(args []string) (code int)

+ func (app *App) RunLine(argsLine string) int

+ func (app *App) SetDefaultCommand(name string)

+ func (b *App) AddError(err error)

+ func (b *App) AliasesMapping() map[string]string

+ func (b *App) CmdAliases() *structs.Aliases

+ func (b *App) CmdNameMap() map[string]int

+ func (b *App) CmdNames() []string

+ func (b *App) Command(name string) (c *Command, exist bool)

+ func (b *App) CommandNames() []string

+ func (b *App) Commands() map[string]*Command

+ func (b *App) FindByPath(path string) *Command

+ func (b *App) FindCommand(path string) *Command

+ func (b *App) GetCommand(name string) *Command

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

+ func (b *App) HasCommands() bool

+ func (b *App) IsAlias(alias string) bool

+ func (b *App) IsCommand(name string) bool

+ func (b *App) Match(names []string) *Command

+ func (b *App) MatchByPath(path string) *Command

+ func (b *App) ResolveAlias(alias string) string

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

+ func (c App) GlobalFlags() *Flags

+ func (c App) RawOsArgs() []string

+ 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) Init() *Argument

+ 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) With(fn func(arg *Argument)) *Argument

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

+ type Arguments struct

+ 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) HasArgs() bool

+ func (ags *Arguments) HasArguments() 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 Command struct

+ Aliases []string

+ Category string

+ Config func(c *Command)

+ Desc string

+ Examples string

+ Func RunnerFunc

+ Help string

+ HelpRender func(c *Command)

+ Name string

+ Subs []*Command

+ func NewCommand(name, desc string, fn ...func(c *Command)) *Command

+ func (b *Command) AddError(err error)

+ func (b *Command) AliasesMapping() map[string]string

+ func (b *Command) CmdAliases() *structs.Aliases

+ func (b *Command) CmdNameMap() map[string]int

+ func (b *Command) CmdNames() []string

+ func (b *Command) Command(name string) (c *Command, exist bool)

+ func (b *Command) CommandNames() []string

+ func (b *Command) Commands() map[string]*Command

+ func (b *Command) FindByPath(path string) *Command

+ func (b *Command) FindCommand(path string) *Command

+ func (b *Command) GetCommand(name string) *Command

+ func (b *Command) HasCommand(name string) bool

+ func (b *Command) HasCommands() bool

+ func (b *Command) IsAlias(alias string) bool

+ func (b *Command) IsCommand(name string) bool

+ func (b *Command) ResolveAlias(alias string) string

+ func (b *Command) SetLogo(logo string, style ...string)

+ func (c *Command) Add(sub *Command, more ...*Command)

+ func (c *Command) AddCommand(sub *Command)

+ func (c *Command) AddSubs(sub *Command, more ...*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{}) (stop bool)

+ func (c *Command) GFlags() *Flags

+ func (c *Command) HelpDesc() (desc string)

+ func (c *Command) ID() string

+ func (c *Command) Init()

+ func (c *Command) IsDisabled() bool

+ func (c *Command) IsRoot() bool

+ func (c *Command) IsStandalone() bool

+ func (c *Command) IsSubCommand(name string) bool

+ func (c *Command) Match(names []string) *Command

+ func (c *Command) MatchByPath(path string) *Command

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

+ func (c *Command) Next()

+ func (c *Command) NotStandalone() bool

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

+ func (c *Command) Parent() *Command

+ func (c *Command) ParentName() string

+ func (c *Command) Path() string

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

+ func (c *Command) Root() *Command

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

+ func (c *Command) Runnable() bool

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

+ func (c *Command) SetParent(parent *Command)

+ func (c *Command) ShowHelp()

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

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

+ func (c *Command) WithFunc(fn RunnerFunc) *Command

+ func (c Command) GlobalFlags() *Flags

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

+ type Commander interface

+ SetValue func(string, interface{})

+ Value func(string) interface{}

+ type EnumString struct

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

+ func (s *EnumString) String() string

+ type FlagMeta struct

+ Alias string

+ 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

+ Desc string

+ ExitFunc func(code int)

+ func NewFlags(nameWithDesc ...string) *Flags

+ func (fs *Flags) Bool(name, shorts string, defValue bool, desc string) *bool

+ 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) FSetArgs() []string

+ 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(s 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) Int(name, shorts string, defValue int, desc string) *int

+ func (fs *Flags) Int64(name, shorts string, defValue int64, desc string) *int64

+ 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) Required(names ...string)

+ func (fs *Flags) Run(args []string)

+ func (fs *Flags) SetFlagSet(fSet *flag.FlagSet)

+ func (fs *Flags) SetHelpRender(fn func())

+ func (fs *Flags) SetOptions(opt *FlagsOption)

+ func (fs *Flags) SetOutput(out io.Writer)

+ func (fs *Flags) ShortNames(name string) (ss []string)

+ func (fs *Flags) Str(name, shorts string, defValue, desc string) *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) Uint(name, shorts string, defValue uint, desc string) *uint

+ func (fs *Flags) Uint64(name, shorts string, defValue uint64, desc string) *uint64

+ 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) WithOptions(fns func(opt *FlagsOption)) *Flags

+ type FlagsOption struct

+ Alignment uint8

+ NameDescOL bool

+ TagName string

+ WithoutType bool

+ type GOptions struct

+ NoColor bool

+ func GOpts() *GOptions

+ func (g *GOptions) NoInteractive() bool

+ func (g *GOptions) NoProgress() bool

+ func (g *GOptions) SetStrictMode(strictMode bool)

+ func (g *GOptions) SetVerbose(verbose VerbLevel)

+ func (g *GOptions) Verbose() VerbLevel

+ type Handler interface

+ Config func(c *Command)

+ Creator func() *Command

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

+ type HandlersChain []RunnerFunc

+ func (c HandlersChain) Last() RunnerFunc

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

+ App *App

+ Cmd *Command

+ func (hc *HookCtx) Name() string

+ func (md *HookCtx) ClearData()

+ func (md *HookCtx) Data() map[string]interface{}

+ func (md *HookCtx) IntValue(key string) int

+ func (md *HookCtx) SetData(data map[string]interface{})

+ func (md *HookCtx) SetValue(key string, val interface{})

+ func (md *HookCtx) StrValue(key string) string

+ func (md *HookCtx) Value(key string) interface{}

+ type HookFunc func(data ...interface{}) (stop bool)

+ type Hooks struct

+ func (h *Hooks) AddOn(name string, handler HookFunc)

+ func (h *Hooks) ClearHooks()

+ func (h *Hooks) Fire(event string, data ...interface{}) (stop bool)

+ func (h *Hooks) HasHook(event string) bool

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

+ func (f RunnerFunc) Run(c *Command, args []string) error

+ type SimplePrinter struct

+ func (s SimplePrinter) Errorln(a ...interface{})

+ func (s SimplePrinter) Infoln(a ...interface{})

+ func (s SimplePrinter) Print(v ...interface{})

+ func (s SimplePrinter) Printf(format string, v ...interface{})

+ func (s SimplePrinter) Println(v ...interface{})

+ func (s SimplePrinter) Warnln(a ...interface{})

+ type Strings []string

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

+ func (s *Strings) String() string

+ type VerbLevel uint

+ const VerbCrazy

+ const VerbDebug

+ const VerbError

+ const VerbInfo

+ const VerbQuiet

+ const VerbWarn

+ func Verbose() VerbLevel

+ func (vl *VerbLevel) Set(value string) error

+ func (vl VerbLevel) Int() int

+ func (vl VerbLevel) Name() string

+ func (vl VerbLevel) String() string

+ func (vl VerbLevel) Upper() string

Other modules containing this package

github.com/gookit/gcli

github.com/gookit/gcli/v2

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