cmdr

README

cmdr

cmdr is a POSIX-compliant, command-line UI (CLI) library in Golang. It is a getopt-like parser of command-line options, be compatible with the getopt_long command line UI, which is an extension of the syntax recommended by POSIX.

We made many enhancements beyond the standard library flag.

There is a fully-functional Options Store (configurations) for your hierarchical configuration dataset too.

The .netCore version Cmdr.Core is available now. And, a cxx version cmdr-cxx was pre-released just now (Happy Spring Festival 2021).

See the image frames at #1.

See our extras:

• cmdr-docs: documentations (Working)
• cmdr-addons: a new daemon plugin dex for linux/macOS/windows.
• cmdr-examples: collects the samples for cmdr
• cmdr-go-starter: public template repo to new your cli app

and Bonus of #cmdr Series:

• dotnetCore: Cmdr.Core
• C++17 or higher: cmdr-cxx

News

• docs (WIP):

  • english documentation NOT completed yet
  • documentation at: https://hedzr.github.io/cmdr-docs/

• v1.10.13 (WIP)

• v1.10.11

  • fix: setNx bug at last commit
  • fix: send 1.10.10 failure

• v1.10.9

  • fix: setNx with slices merging
  • fix: aliases might be added to multiple groups
  • fea: secondary config file locations

• v1.10.8

  • fix/fea/imp: make cmdr aliases subsystem better

• v1.10.7

  • fix: generate shell may be lost buffered contents on writing to file

• v1.10.6

  • fix: internal commands and flags has wrong group declarations since last refactored.
  • fea: -o file for generate shell command.

• v1.10.5

  • fix: logex might crash on a nil skip field

• v1.10.3

  • last release failed because some deps cannot committed due to weak network

• v1.10.1

  • move to go1.17 to get a split declaration
  • fix: added the forgotten long-desc field
  • fix: transfer proper log-level to hedzr/log if in debug/trace mode
  • fix/imp: log.ForDir, ForFile
  • fix: log.LeftPad
  • fea: added InvokeCommand to run a sub-command from somewhere

• v1.10.0

  • fix: toggle-group key not sync while set via envvar
  • imp: speed up by extracting a re compiling code
  • imp: upgrade deps with more enh-helpers from hedzr/log
  • imp: yaml indent size
  • imp: StripOrderPrefix
  • imp/fix: sync debug/trace mode back to hedzr/log
  • fix: options after tail args (positional args) might be ignored
  • fix: ResetOptions not clean up internal hierarchy-list
  • fea: added Checkpoints on Option Store
    you may save and restore multiple checkpoints for cmdr Option Store, so that some temporary changes can be made.
  • fix/imp: --man crashes if manpages not installed - the responding manpage will be generated temporarily and instantly now
  • add GitSummary field into conf package
  • imp: speed up by reduce get worker
    • centralize rxxtOptions to store()
    • flatten backtrace(Flg|Cmd)Names, added dottedPathToCommand
  • NOTE: the phrase wrapped by backtick(````) in Description field will be extracted as DefaultValuePlaceholder field automatically, so beware this feature.
  • fea: -vv (dup -v more than once) will print the hidden commands & flags in help screen NOW.
    To take a sight of running fluent generate --help --verbose -verbose.
  • ...

• v1.9.9

  • improved: prevent sent to closed channel defensively
  • SPECIAL: needs go1.16+ because some indirect-dep-lib wants io/fs (such as .../toml, zap ...).

• v1.9.8

  • upgrade log and logex
  • added DebugOutputTildeInfo()

• v1.9.7

  • fixed: dead-lock while setting up env keys

• v1.9.6

  • fixed: incorrect rune count at calc escaped text in help screen.
  • remove deprecated internal options: --help-zsh, --help-bash
  • add new option --man to enter manpage entry of a sub-command, try fluent ms tags ls --man. [linux/darwin only]
  • fixed: Flag.Action return err but cmdr.Exec no breaking its flow.

• v1.9.5

  • improved: zsh completion generator (app gen sh --zsh/--auto) - supports unlimited nested sub-command now.

• v1.9.4

  • fixed: potential nil exception while writing back to the alternative config files
  • fixed: wrong calculating on remain args sometimes
  • improved: rewrote builtin options constructions
  • added 'cmdr.version' into Option Store
  • added some tool helpers
  • improved: zsh completion generator (app gen sh --zsh/--auto)

• v1.9.3

  • fixed: commands might not work when loading from config file. ref: fluent services kx3, and/or fluent ls/pwd
  • fixed: incorrect usage on bytes.Buffer, for toggle-group choicer

• v1.9.2

  • fixed: parsing not stop while a should-be-stopped flag (such as --version) found
  • fixed: incorrect usage line at top level help screen
  • improved: better toggle-group show in help screen
    new style for ToggleGroup items: A unicode character '⬡'(U+2B21) as the prefix of the option description. (see here)
  • improved: better toggle-group choicer in help screen 1. '⬢'(U+2B22) & '⬡'(U+2B21) for the default choicer style (named as hexagon), 1. '▸'(U+25B8) & '▹'(U+25B9) as another one (triangle-right),
  • improved: WithToggleGroupChoicerStyle(style) and WithToggleGroupChoicerNewStyle(style, trueChoicer, falseChoicer).

• v1.9.1:

  • A public template repo may simplify your new CLI app: cmdr-go-starter.
  • crashed at an elder fsnotify on macOS, with go1.17
  • minor fixes

• v1.9.0

  • .fossa.yaml so a pre-release scan can be launched locally
  • BREAK: remove plugin/daemon - use cmdr-addons/pkg/plugins/dex instead
  • updated log, added: closers, detects and more
  • use closers for better closing hooks
  • just a early BREAK release

• More details at CHANGELOG

Features

Features.md

Old README.md: README.old.md

For Developer

For Developer

Import cmdr

With go-modules enabled:

import "github.com/hedzr/cmdr"

About the Docker build

Here is a docker build for cmdr/examples/fluent so that you can run it without go building or downloading the release files:

# from Docker Hub:
$ docker run -it --rm hedzr/cmdr-fluent
$ docker run -it --rm hedzr/cmdr-fluent --help

# from Github Packages (please following the guide of GitHub Packages Site):
$ docker run -it --rm docker.pkg.github.com/hedzr/cmdr/cmdr-fluent
$ docker run -it --rm docker.pkg.github.com/hedzr/cmdr/cmdr-fluent --help

Examples

1. short
   simple codes with structured data style.

2. demo
   normal demo with external config files.

3. wget-demo
   partial-covered for GNU wget.

4. fluent
   demostrates how to define your command-ui with the fluent api style.

5. ffdemo

   a demo to show you how to migrate from go flag smoothly.

6. cmdr-http2
   http2 server with daemon supports, graceful shutdown

7. awesome-tool
   awesome-tool is a cli app that fetch the repo stars and generate a markdown summary, accordingly with most of awesome-xxx list in github (such as awesome-go).

See Also the examples index: Examples.md (zh-cn TODO: Examples.zh-cn.md)

Uses

• https://github.com/hedzr/consul-tags
• https://github.com/hedzr/ini-op
• https://github.com/hedzr/awesome-tool
• austr
• Issue me to adding yours

Contrib

Feel free to issue me bug reports and fixes. Many thanks to all contributors.

Thanks to JODL

Thanks to JetBrains for donating product licenses to help develop cmdr

License

MIT

Documentation

Overview

Package cmdr is a golang library to interpret/parse the command-line input with POSIX-compliant mode

Index

• Constants
• Variables
• func AddOnConfigLoadedListener(c ConfigReloaded)
• func AsJSON() (b []byte)
• func AsJSONExt() (b []byte, err error)
• func AsToml() (b []byte)
• func AsTomlExt() (b []byte, err error)
• func AsYaml() (b []byte)
• func AsYamlExt() (b []byte, err error)
• func CheckpointSize() int
• func ClearCheckpoints()
• func Clone(fromValue, toValue interface{}) interface{}
• func CloneViaGob(to, from interface{}) (err error)
• func DebugOutputTildeInfo(showType bool)
• func DeleteKey(key string)
• func DottedPathToCommandOrFlag(dottedPath string, anyCmd *Command) (cc *Command, ff *Flag)
• func DumpAsString() (str string)
• func EnableShellPager(enabled bool)
• func Exec(rootCmd *RootCommand, opts ...ExecOption) (err error)
• func Get(key string) interface{}
• func GetBool(key string, defaultVal ...bool) bool
• func GetBoolP(prefix, key string, defaultVal ...bool) bool
• func GetBoolR(key string, defaultVal ...bool) bool
• func GetBoolRP(prefix, key string, defaultVal ...bool) bool
• func GetComplex128(key string, defaultVal ...complex128) complex128
• func GetComplex128P(prefix, key string, defaultVal ...complex128) complex128
• func GetComplex128R(key string, defaultVal ...complex128) complex128
• func GetComplex128RP(prefix, key string, defaultVal ...complex128) complex128
• func GetComplex64(key string, defaultVal ...complex64) complex64
• func GetComplex64P(prefix, key string, defaultVal ...complex64) complex64
• func GetComplex64R(key string, defaultVal ...complex64) complex64
• func GetComplex64RP(prefix, key string, defaultVal ...complex64) complex64
• func GetDebugMode() bool
• func GetDebugModeHitCount() int
• func GetDuration(key string, defaultVal ...time.Duration) time.Duration
• func GetDurationP(prefix, key string, defaultVal ...time.Duration) time.Duration
• func GetDurationR(key string, defaultVal ...time.Duration) time.Duration
• func GetDurationRP(prefix, key string, defaultVal ...time.Duration) time.Duration
• func GetFlagHitCount(longName string) int
• func GetFlagHitCountRecursively(longName string) int
• func GetFloat32(key string, defaultVal ...float32) float32
• func GetFloat32P(prefix, key string, defaultVal ...float32) float32
• func GetFloat32R(key string, defaultVal ...float32) float32
• func GetFloat32RP(prefix, key string, defaultVal ...float32) float32
• func GetFloat64(key string, defaultVal ...float64) float64
• func GetFloat64P(prefix, key string, defaultVal ...float64) float64
• func GetFloat64R(key string, defaultVal ...float64) float64
• func GetFloat64RP(prefix, key string, defaultVal ...float64) float64
• func GetHierarchyList() map[string]interface{}
• func GetHitCountByDottedPath(dottedPath string) int
• func GetInt(key string, defaultVal ...int) int
• func GetInt64(key string, defaultVal ...int64) int64
• func GetInt64P(prefix, key string, defaultVal ...int64) int64
• func GetInt64R(key string, defaultVal ...int64) int64
• func GetInt64RP(prefix, key string, defaultVal ...int64) int64
• func GetInt64Slice(key string, defaultVal ...int64) []int64
• func GetInt64SliceP(prefix, key string, defaultVal ...int64) []int64
• func GetInt64SliceR(key string, defaultVal ...int64) []int64
• func GetInt64SliceRP(prefix, key string, defaultVal ...int64) []int64
• func GetIntP(prefix, key string, defaultVal ...int) int
• func GetIntR(key string, defaultVal ...int) int
• func GetIntRP(prefix, key string, defaultVal ...int) int
• func GetIntSlice(key string, defaultVal ...int) []int
• func GetIntSliceP(prefix, key string, defaultVal ...int) []int
• func GetIntSliceR(key string, defaultVal ...int) []int
• func GetIntSliceRP(prefix, key string, defaultVal ...int) []int
• func GetKibibytes(key string, defaultVal ...uint64) uint64
• func GetKibibytesP(prefix, key string, defaultVal ...uint64) uint64
• func GetKibibytesR(key string, defaultVal ...uint64) uint64
• func GetKibibytesRP(prefix, key string, defaultVal ...uint64) uint64
• func GetKilobytes(key string, defaultVal ...uint64) uint64
• func GetKilobytesP(prefix, key string, defaultVal ...uint64) uint64
• func GetKilobytesR(key string, defaultVal ...uint64) uint64
• func GetKilobytesRP(prefix, key string, defaultVal ...uint64) uint64
• func GetMap(key string) map[string]interface{}
• func GetMapR(key string) map[string]interface{}
• func GetNoColorMode() bool
• func GetNoColorModeHitCount() int
• func GetPredefinedAlterLocations() []string
• func GetPredefinedLocations() []string
• func GetQuietMode() bool
• func GetQuietModeHitCount() int
• func GetR(key string) interface{}
• func GetRemainArgs() []string
• func GetSecondaryLocations() []string
• func GetSectionFrom(sectionKeyPath string, holder interface{}) (err error)
• func GetStrictMode() bool
• func GetString(key string, defaultVal ...string) string
• func GetStringNoExpand(key string, defaultVal ...string) string
• func GetStringNoExpandP(prefix, key string, defaultVal ...string) string
• func GetStringNoExpandR(key string, defaultVal ...string) string
• func GetStringNoExpandRP(prefix, key string, defaultVal ...string) string
• func GetStringP(prefix, key string, defaultVal ...string) string
• func GetStringR(key string, defaultVal ...string) string
• func GetStringRP(prefix, key string, defaultVal ...string) string
• func GetStringSlice(key string, defaultVal ...string) []string
• func GetStringSliceP(prefix, key string, defaultVal ...string) []string
• func GetStringSliceR(key string, defaultVal ...string) []string
• func GetStringSliceRP(prefix, key string, defaultVal ...string) []string
• func GetTraceMode() bool
• func GetTraceModeHitCount() int
• func GetUint(key string, defaultVal ...uint) uint
• func GetUint64(key string, defaultVal ...uint64) uint64
• func GetUint64P(prefix, key string, defaultVal ...uint64) uint64
• func GetUint64R(key string, defaultVal ...uint64) uint64
• func GetUint64RP(prefix, key string, defaultVal ...uint64) uint64
• func GetUint64Slice(key string, defaultVal ...uint64) []uint64
• func GetUint64SliceP(prefix, key string, defaultVal ...uint64) []uint64
• func GetUint64SliceR(key string, defaultVal ...uint64) []uint64
• func GetUint64SliceRP(prefix, key string, defaultVal ...uint64) []uint64
• func GetUintP(prefix, key string, defaultVal ...uint) uint
• func GetUintR(key string, defaultVal ...uint) uint
• func GetUintRP(prefix, key string, defaultVal ...uint) uint
• func GetUsedAlterConfigFile() string
• func GetUsedConfigFile() string
• func GetUsedConfigSubDir() string
• func GetUsedSecondaryConfigFile() string
• func GetUsedSecondaryConfigSubDir() string
• func GetUsingConfigFiles() []string
• func GetVerboseMode() bool
• func GetVerboseModeHitCount() int
• func GetWatchingConfigFiles() []string
• func HasKey(key string) (ok bool)
• func InDebugging() bool
• func InDevelopingTime() (status bool)
• func InDockerEnv() (status bool)
• func InTesting() bool
• func InvokeCommand(dottedCommandPath string, extraArgs ...string) (err error)
• func IsDebuggerAttached() bool
• func IsZero(v reflect.Value) bool
• func LoadConfigFile(file string) (mainFile, subDir string, err error)
• func MergeWith(m map[string]interface{}) (err error)
• func NewLoggerConfig() *log.LoggerConfig
• func NewLoggerConfigWith(enabled bool, backend, level string) *log.LoggerConfig
• func RemoveOnConfigLoadedListener(c ConfigReloaded)
• func ResetOptions()
• func RestoreCheckpoint(n ...int) (err error)
• func SaveAsJSON(filename string) (err error)
• func SaveAsToml(filename string) (err error)
• func SaveAsYaml(filename string) (err error)
• func SaveCheckpoint() (err error)
• func SaveObjAsToml(obj interface{}, filename string) (err error)
• func Set(key string, val interface{})
• func SetDebugMode(b bool)
• func SetLogger(l log.Logger)
• func SetNx(key string, val interface{})
• func SetOnConfigLoadedListener(c ConfigReloaded, enabled bool)
• func SetRaw(key string, val interface{})
• func SetTraceMode(b bool)
• func SignalQuitSignal()
• func SignalTermSignal()
• func SignalToSelf(sig os.Signal) (err error)
• func ToBool(val interface{}, defaultVal ...bool) (ret bool)
• func TrapSignals(onTrapped func(s os.Signal), signals ...os.Signal) (waiter func())
• func TrapSignalsEnh(done chan bool, onTrapped func(s os.Signal), signals ...os.Signal) (waiter func())
• func WalkAllCommands(walk func(cmd *Command, index, level int) (err error)) (err error)
• func WrapWithRxxtPrefix(key string) string
• type BaseOpt
  • func (s *BaseOpt) GetDescZsh() (desc string)
  • func (s *BaseOpt) GetLongTitleNamesArray() []string
  • func (s *BaseOpt) GetShortTitleNamesArray() []string
  • func (s *BaseOpt) GetTitleName() string
  • func (s *BaseOpt) GetTitleNames() string
  • func (s *BaseOpt) GetTitleNamesArray() []string
  • func (s *BaseOpt) GetTitleNamesArrayMainly() []string
  • func (s *BaseOpt) GetTitleNamesBy(delimChar string) string
  • func (s *BaseOpt) GetTitleZshNames() string
  • func (s *BaseOpt) GetTitleZshNamesBy(delimChar string) (str string)
  • func (s *BaseOpt) HasParent() bool
• type Command
  • func DottedPathToCommand(dottedPath string, anyCmd *Command) (cc *Command)
  • func FindSubCommand(longName string, cmd *Command) (res *Command)
  • func FindSubCommandRecursive(longName string, cmd *Command) (res *Command)
  • func Match(inputCommandlineWithoutArg0 string, opts ...ExecOption) (last *Command, err error)
  • func (c *Command) Delete()
  • func (c *Command) FindFlag(longName string) (res *Flag)
  • func (c *Command) FindFlagRecursive(longName string) (res *Flag)
  • func (c *Command) FindSubCommand(longName string) (res *Command)
  • func (c *Command) FindSubCommandRecursive(longName string) (res *Command)
  • func (c *Command) GetDottedNamePath() string
  • func (c *Command) GetExpandableNames() string
  • func (c *Command) GetExpandableNamesArray() []string
  • func (c *Command) GetHitStr() string
  • func (c *Command) GetName() string
  • func (c *Command) GetOwner() *Command
  • func (c *Command) GetParentName() string
  • func (c *Command) GetQuotedGroupName() string
  • func (c *Command) GetRoot() *RootCommand
  • func (c *Command) GetSubCommandNamesBy(delimChar string) string
  • func (c *Command) GetTriggeredTimes() int
  • func (c *Command) IsRoot() bool
  • func (c *Command) PrintBuildInfo()
  • func (c *Command) PrintHelp(justFlags bool)
  • func (c *Command) PrintVersion()
• type ConfigReloaded
• type Copier
• type ErrorForCmdr
  • func (w *ErrorForCmdr) As(target interface{}) bool
  • func (w *ErrorForCmdr) Attach(errs ...error)
  • func (w *ErrorForCmdr) Cause() error
  • func (w *ErrorForCmdr) Error() string
  • func (w *ErrorForCmdr) FormatNew(ignorable bool, livedArgs ...interface{}) *errors.WithStackInfo
  • func (w *ErrorForCmdr) Is(target error) bool
  • func (w *ErrorForCmdr) Unwrap() error
• type ExecOption
  • func WithAfterArgsParsed(hookFunc Handler) ExecOption
  • func WithAlterLocations(locations ...string) ExecOption
  • func WithAutomaticEnvHooks(hook HookOptsFunc) ExecOption
  • func WithBuiltinCommands(versionsCmds, helpCmds, verboseCmds, generateCmds, generalCmdrCmds bool) ExecOption
  • func WithCommandSystemCustomizing(customizer HookFunc) ExecOption
  • func WithConfigFileLoadingHooks(before, after HookFunc) ExecOption
  • func WithConfigLoadedListener(c ConfigReloaded) ExecOption
  • func WithConfigSubDirAutoName(folderName string) ExecOption
  • func WithCustomShowBuildInfo(fn func()) ExecOption
  • func WithCustomShowVersion(fn func()) ExecOption
  • func WithEnvPrefix(prefix ...string) ExecOption
  • func WithEnvVarMap(varToValue map[string]func() string) ExecOption
  • func WithExtensionsLocations(locations ...string) ExecOption
  • func WithGlobalPostActions(fns ...Invoker) ExecOption
  • func WithGlobalPreActions(fns ...Handler) ExecOption
  • func WithHelpPainter(painter Painter) ExecOption
  • func WithHelpScreenHooks(before, after HookHelpScreenFunc) ExecOption
  • func WithHelpTabStop(tabStop int) ExecOption
  • func WithHelpTailLine(line string) ExecOption
  • func WithIgnoreWrongEnumValue(ignored bool) ExecOption
  • func WithInternalOutputStreams(out, err *bufio.Writer) ExecOption
  • func WithLogex(lvl Level, opts ...logex.Option) ExecOption
  • func WithLogexPrefix(prefix string) ExecOption
  • func WithLogexSkipFrames(skipFrames int) ExecOption
  • func WithLogx(logger log.Logger) ExecOption
  • func WithLogxShort(enabled bool, backend, level string) ExecOption
  • func WithNoColor(b bool) ExecOption
  • func WithNoCommandAction(b bool) ExecOption
  • func WithNoDefaultHelpScreen(b bool) ExecOption
  • func WithNoEnvOverrides(b bool) ExecOption
  • func WithNoLoadConfigFiles(b bool) ExecOption
  • func WithNoWatchConfigFiles(b bool) ExecOption
  • func WithOnPassThruCharHit(fn func(parsed *Command, switchChar string, args []string) (err error)) ExecOption
  • func WithOnSwitchCharHit(fn func(parsed *Command, switchChar string, args []string) (err error)) ExecOption
  • func WithOptionMergeModifying(onMergingSet func(keyPath string, value, oldVal interface{})) ExecOption
  • func WithOptionModifying(onOptionSet func(keyPath string, value, oldVal interface{})) ExecOption
  • func WithOptionsPrefix(prefix ...string) ExecOption
  • func WithPagerEnabled(enabled ...bool) ExecOption
  • func WithPluginLocations(locations ...string) ExecOption
  • func WithPredefinedLocations(locations ...string) ExecOption
  • func WithRxxtPrefix(prefix ...string) ExecOption
  • func WithSearchAlterConfigFiles(b bool) ExecOption
  • func WithSecondaryLocations(locations ...string) ExecOption
  • func WithSimilarThreshold(similarThreshold float64) ExecOption
  • func WithStrictMode(b bool) ExecOption
  • func WithToggleGroupChoicerNewStyle(style string, trueChoicer, falseChoicer string) ExecOption
  • func WithToggleGroupChoicerStyle(style string) ExecOption
  • func WithUnhandledErrorHandler(handler UnhandledErrorHandler) ExecOption
  • func WithUnknownOptionHandler(handler UnknownOptionHandler) ExecOption
  • func WithWarnForUnknownCommand(b bool) ExecOption
  • func WithWatchMainConfigFileToo(b bool) ExecOption
  • func WithXrefBuildingHooks(beforeXrefBuildingX, afterXrefBuiltX HookFunc) ExecOption
• type ExecWorker
  • func (w *ExecWorker) AddOnAfterXrefBuilt(cb HookFunc)
  • func (w *ExecWorker) AddOnBeforeXrefBuilding(cb HookFunc)
  • func (w *ExecWorker) InternalExecFor(rootCmd *RootCommand, args []string) (last *Command, err error)
• type Flag
  • func FindFlag(longName string, cmd *Command) (res *Flag)
  • func FindFlagRecursive(longName string, cmd *Command) (res *Flag)
  • func (f *Flag) Delete()
  • func (f *Flag) GetDescZsh() (desc string)
  • func (f *Flag) GetTitleFlagNames() string
  • func (f *Flag) GetTitleFlagNamesBy(delimChar string) string
  • func (f *Flag) GetTitleFlagNamesByMax(delimChar string, maxShort int) string
  • func (f *Flag) GetTitleZshFlagName() (str string)
  • func (f *Flag) GetTitleZshFlagNamesArray() (ary []string)
  • func (f *Flag) GetTitleZshFlagShortName() (str string)
  • func (f *Flag) GetTitleZshNamesBy(delimChar string, allowPrefix, quoted bool) (str string)
  • func (f *Flag) GetTitleZshNamesExtBy(delimChar string, allowPrefix, quoted, shortTitleOnly, longTitleOnly bool) (str string)
  • func (f *Flag) GetTriggeredTimes() int
• type Handler
• type HookFunc
• type HookHelpScreenFunc
• type HookOptsFunc
• type Invoker
• type Level
  • func GetLoggerLevel() Level
  • func ParseLevel(lvl string) (Level, error)
  • func (level Level) MarshalText() ([]byte, error)
  • func (level Level) String() string
  • func (level *Level) UnmarshalText(text []byte) error
• type OnOptionSetCB
• type OnPassThruCharHitCB
• type OnSet
• type OnSwitchCharHitCB
• type OptCmd
  • func NewCmd() (opt OptCmd)
  • func NewCmdFrom(cmd *Command) (opt OptCmd)
  • func NewSubCmd() (opt OptCmd)
• type OptFlag
  • func NewBool(defaultValue ...bool) (opt OptFlag)
  • func NewComplex128(defaultValue ...complex128) (opt OptFlag)
  • func NewComplex64(defaultValue ...complex64) (opt OptFlag)
  • func NewDuration(defaultValue ...time.Duration) (opt OptFlag)
  • func NewDurationFrom(flg *Flag) (opt OptFlag)
  • func NewFloat32(defaultValue ...float32) (opt OptFlag)
  • func NewFloat64(defaultValue ...float64) (opt OptFlag)
  • func NewInt(defaultValue ...int) (opt OptFlag)
  • func NewInt64(defaultValue ...int64) (opt OptFlag)
  • func NewIntSlice(defaultValue ...int) (opt OptFlag)
  • func NewString(defaultValue ...string) (opt OptFlag)
  • func NewStringSlice(defaultValue ...string) (opt OptFlag)
  • func NewUint(defaultValue ...uint) (opt OptFlag)
  • func NewUint64(defaultValue ...uint64) (opt OptFlag)
  • func NewUintSlice(defaultValue ...uint) (opt OptFlag)
• type OptFlagType
• type Options
  • func GetOptions() *Options
  • func (s *Options) CheckpointSize() int
  • func (s *Options) ClearCheckpoints()
  • func (s *Options) Delete(key string)
  • func (s *Options) DumpAsString(showType bool) (str string)
  • func (s *Options) Flush()
  • func (s *Options) FromKibiBytes(sz string) (ir64 uint64)
  • func (s *Options) FromKilobytes(sz string) (ir64 uint64)
  • func (s *Options) Get(key string) interface{}
  • func (s *Options) GetBoolEx(key string, defaultVal ...bool) (ret bool)
  • func (s *Options) GetComplex128(key string, defaultVal ...complex128) (ir complex128)
  • func (s *Options) GetComplex64(key string, defaultVal ...complex64) (ir complex64)
  • func (s *Options) GetDuration(key string, defaultVal ...time.Duration) (ir time.Duration)
  • func (s *Options) GetFloat32Ex(key string, defaultVal ...float32) (ir float32)
  • func (s *Options) GetFloat64Ex(key string, defaultVal ...float64) (ir float64)
  • func (s *Options) GetHierarchyList() map[string]interface{}
  • func (s *Options) GetInt64Ex(key string, defaultVal ...int64) (ir int64)
  • func (s *Options) GetInt64Slice(key string, defaultVal ...int64) (ir []int64)
  • func (s *Options) GetIntEx(key string, defaultVal ...int) (ir int)
  • func (s *Options) GetIntSlice(key string, defaultVal ...int) (ir []int)
  • func (s *Options) GetKibibytesEx(key string, defaultVal ...uint64) (ir64 uint64)
  • func (s *Options) GetKilobytesEx(key string, defaultVal ...uint64) (ir64 uint64)
  • func (s *Options) GetMap(key string) map[string]interface{}
  • func (s *Options) GetString(key string, defaultVal ...string) (ret string)
  • func (s *Options) GetStringNoExpand(key string, defaultVal ...string) (ret string)
  • func (s *Options) GetStringSlice(key string, defaultVal ...string) (ir []string)
  • func (s *Options) GetUint64Ex(key string, defaultVal ...uint64) (ir uint64)
  • func (s *Options) GetUint64Slice(key string, defaultVal ...uint64) (ir []uint64)
  • func (s *Options) GetUintEx(key string, defaultVal ...uint) (ir uint)
  • func (s *Options) Has(key string) (ok bool)
  • func (s *Options) LoadConfigFile(file string, cft configFileType) (mainFile, subDir string, err error)
  • func (s *Options) MergeWith(m map[string]interface{}) (err error)
  • func (s *Options) Reset()
  • func (s *Options) RestoreCheckpoint(n ...int) (err error)
  • func (s *Options) SaveCheckpoint() (err error)
  • func (s *Options) Set(key string, val interface{})
  • func (s *Options) SetNx(key string, val interface{})
  • func (s *Options) SetRaw(key string, val interface{})
• type Painter
• type RootCmdOpt
  • func Root(appName, version string) (opt *RootCmdOpt)
  • func RootFrom(root *RootCommand) (opt *RootCmdOpt)
  • func (s *RootCmdOpt) Action(action Handler) (opt OptCmd)
  • func (s *RootCmdOpt) AddCommand(cmd *Command)
  • func (s *RootCmdOpt) AddFlag(flag *Flag)
  • func (s *RootCmdOpt) AddGlobalPostAction(post Invoker) *RootCmdOpt
  • func (s *RootCmdOpt) AddGlobalPreAction(pre Handler) *RootCmdOpt
  • func (s *RootCmdOpt) AddOptCmd(opt OptCmd)
  • func (s *RootCmdOpt) AddOptFlag(flag OptFlag)
  • func (s *RootCmdOpt) Aliases(aliases ...string) (opt OptCmd)
  • func (s *RootCmdOpt) AppendPostActions(fns ...func(cmd *Command, args []string))
  • func (s *RootCmdOpt) AppendPreActions(fns ...func(cmd *Command, args []string) (err error))
  • func (s *RootCmdOpt) AttachTo(opt OptCmd)
  • func (s *RootCmdOpt) AttachToCommand(cmd *Command)
  • func (s *RootCmdOpt) AttachToRoot(root *RootCommand)
  • func (s *RootCmdOpt) Bool() (opt OptFlag)
  • func (s *RootCmdOpt) Complex128() (opt OptFlag)
  • func (s *RootCmdOpt) Complex64() (opt OptFlag)
  • func (s *RootCmdOpt) Copyright(copyright, author string) *RootCmdOpt
  • func (s *RootCmdOpt) Deprecated(deprecation string) (opt OptCmd)
  • func (s *RootCmdOpt) Description(oneLine string, long ...string) (opt OptCmd)
  • func (s *RootCmdOpt) Duration() (opt OptFlag)
  • func (s *RootCmdOpt) Examples(examples string) (opt OptCmd)
  • func (s *RootCmdOpt) Float32() (opt OptFlag)
  • func (s *RootCmdOpt) Float64() (opt OptFlag)
  • func (s *RootCmdOpt) Group(group string) (opt OptCmd)
  • func (s *RootCmdOpt) Header(header string) *RootCmdOpt
  • func (s *RootCmdOpt) Hidden(hidden bool) (opt OptCmd)
  • func (s *RootCmdOpt) Int() (opt OptFlag)
  • func (s *RootCmdOpt) Int64() (opt OptFlag)
  • func (s *RootCmdOpt) IntSlice() (opt OptFlag)
  • func (s *RootCmdOpt) Long(long string) (opt OptCmd)
  • func (s *RootCmdOpt) Name(name string) (opt OptCmd)
  • func (s *RootCmdOpt) NewFlag(typ OptFlagType) (opt OptFlag)
  • func (s *RootCmdOpt) NewFlagV(defaultValue interface{}, titles ...string) (opt OptFlag)
  • func (s *RootCmdOpt) NewSubCommand(titles ...string) (opt OptCmd)
  • func (s *RootCmdOpt) OwnerCommand() (opt OptCmd)
  • func (s *RootCmdOpt) PostAction(post Invoker) (opt OptCmd)
  • func (s *RootCmdOpt) PreAction(pre Handler) (opt OptCmd)
  • func (s *RootCmdOpt) RootCmdOpt() (root *RootCmdOpt)
  • func (s *RootCmdOpt) RootCommand() (root *RootCommand)
  • func (s *RootCmdOpt) SetOwner(opt OptCmd)
  • func (s *RootCmdOpt) Short(short string) (opt OptCmd)
  • func (s *RootCmdOpt) String() (opt OptFlag)
  • func (s *RootCmdOpt) StringSlice() (opt OptFlag)
  • func (s *RootCmdOpt) TailPlaceholder(placeholder string) (opt OptCmd)
  • func (s *RootCmdOpt) Titles(long, short string, aliases ...string) (opt OptCmd)
  • func (s *RootCmdOpt) ToCommand() *Command
  • func (s *RootCmdOpt) Uint() (opt OptFlag)
  • func (s *RootCmdOpt) Uint64() (opt OptFlag)
• type RootCommand
  • func (c *RootCommand) AppendPostActions(fns ...func(cmd *Command, args []string))
  • func (c *RootCommand) AppendPreActions(fns ...func(cmd *Command, args []string) (err error))
• type UnhandledErrorHandler
• type UnknownOptionHandler

Constants

const (

	// UnsortedGroup for commands and flags
	UnsortedGroup = "zzzg.unsorted"
	// AddonsGroup for commands and flags
	AddonsGroup = "zzzh.Addons"
	// ExtGroup for commands and flags
	ExtGroup = "zzzi.Extensions"
	// AliasesGroup for commands and flags
	AliasesGroup = "zzzj.Aliases"
	// SysMgmtGroup for commands and flags
	SysMgmtGroup = "zzz9.Misc"

	// DefaultEditor is 'vim'
	DefaultEditor = "vim"

	// ExternalToolEditor environment variable name, EDITOR is fit for most of shells.
	ExternalToolEditor = "EDITOR"

	// ExternalToolPasswordInput enables secure password input without echo.
	ExternalToolPasswordInput = "PASSWD"
)

const (
	// AppName const
	AppName = "cmdr"
	// Version const
	Version = "1.10.11"
	// VersionInt const
	VersionInt = 0x010a0b
)

const (

	// FgBlack terminal color code
	FgBlack = 30
	// FgRed terminal color code
	FgRed = 31
	// FgGreen terminal color code
	FgGreen = 32
	// FgYellow terminal color code
	FgYellow = 33
	// FgBlue terminal color code
	FgBlue = 34
	// FgMagenta terminal color code
	FgMagenta = 35
	// FgCyan terminal color code
	FgCyan = 36
	// FgLightGray terminal color code
	FgLightGray = 37
	// FgDarkGray terminal color code
	FgDarkGray = 90
	// FgLightRed terminal color code
	FgLightRed = 91
	// FgLightGreen terminal color code
	FgLightGreen = 92
	// FgLightYellow terminal color code
	FgLightYellow = 93
	// FgLightBlue terminal color code
	FgLightBlue = 94
	// FgLightMagenta terminal color code
	FgLightMagenta = 95
	// FgLightCyan terminal color code
	FgLightCyan = 96
	// FgWhite terminal color code
	FgWhite = 97

	// BgNormal terminal color code
	BgNormal = 0
	// BgBoldOrBright terminal color code
	BgBoldOrBright = 1
	// BgDim terminal color code
	BgDim = 2
	// BgItalic terminal color code
	BgItalic = 3
	// BgUnderline terminal color code
	BgUnderline = 4
	// BgUlink terminal color code
	BgUlink = 5
	// BgHidden terminal color code
	BgHidden = 8

	// DarkColor terminal color code
	DarkColor = FgLightGray
)

Variables

var (
	// GormDefaultCopier used for gorm
	GormDefaultCopier = &copierImpl{KeepIfFromIsNil: true, ZeroIfEqualsFrom: true, KeepIfFromIsZero: true, EachFieldAlways: true}
	// StandardCopier is a normal copier
	StandardCopier = &copierImpl{}
)

var (
	// ErrShouldBeStopException tips `Exec()` cancelled the following actions after `PreAction()`
	ErrShouldBeStopException = newErrorWithMsg("stop me right now")

	// ErrBadArg is a generic error for user
	ErrBadArg = newErrorWithMsg("bad argument")
)

var (

	// CurrentHiddenColor the print color for left part of a hidden opt
	CurrentHiddenColor = FgDarkGray

	// CurrentDeprecatedColor the print color for deprecated opt line
	CurrentDeprecatedColor = FgDarkGray

	// CurrentDescColor the print color for description line
	CurrentDescColor = FgDarkGray
	// CurrentDefaultValueColor the print color for default value line
	CurrentDefaultValueColor = FgDarkGray
	// CurrentGroupTitleColor the print color for titles
	CurrentGroupTitleColor = DarkColor
)

var AllLevels = []Level{
	PanicLevel,
	FatalLevel,
	ErrorLevel,
	WarnLevel,
	InfoLevel,
	DebugLevel,
	TraceLevel,
	OffLevel,
}

AllLevels is a constant exposing all logging levels

var Logger log.Logger = log.NewDummyLogger()

Logger for cmdr

Functions

func AddOnConfigLoadedListener

func AddOnConfigLoadedListener(c ConfigReloaded)

AddOnConfigLoadedListener adds an functor on config loaded and merged

func AsJSON

func AsJSON() (b []byte)

AsJSON returns a json string bytes about all options

func AsJSONExt

func AsJSONExt() (b []byte, err error)

AsJSONExt returns a json string bytes about all options

func AsToml

func AsToml() (b []byte)

AsToml returns a toml string bytes about all options

func AsTomlExt

func AsTomlExt() (b []byte, err error)

AsTomlExt returns a toml string bytes about all options

func AsYaml

func AsYaml() (b []byte)

AsYaml returns a yaml string bytes about all options

func AsYamlExt

func AsYamlExt() (b []byte, err error)

AsYamlExt returns a yaml string bytes about all options

func CheckpointSize

func CheckpointSize() int

CheckpointSize returns how many snapshots made see also SaveCheckpoint

func ClearCheckpoints

func ClearCheckpoints()

ClearCheckpoints removes all checkpoints from snapshot history see also SaveCheckpoint

func Clone

func Clone(fromValue, toValue interface{}) interface{}

Clone deep copy source to target

func CloneViaGob

func CloneViaGob(to, from interface{}) (err error)

CloneViaGob do deep-clone with gob supports

func DebugOutputTildeInfo

func DebugOutputTildeInfo(showType bool)

DebugOutputTildeInfo prints debug information like `~~debug`

func DeleteKey

func DeleteKey(key string)

DeleteKey deletes a key from cmdr options store

func DottedPathToCommandOrFlag

func DottedPathToCommandOrFlag(dottedPath string, anyCmd *Command) (cc *Command, ff *Flag)

DottedPathToCommandOrFlag searches the matched Command or Flag with the specified dotted-path. The searching will start from root if anyCmd is nil.

func DumpAsString

func DumpAsString() (str string)

DumpAsString for debugging.

func EnableShellPager

func EnableShellPager(enabled bool)

EnableShellPager transfer cmdr stdout to OS pager. The environment variable `PAGER` will be checkout, otherwise `less`.

func Exec

func Exec(rootCmd *RootCommand, opts ...ExecOption) (err error)

Exec is main entry of `cmdr`.

func Get

func Get(key string) interface{}

Get returns the generic value of an `Option` key with WrapWithRxxtPrefix. Such as: ```golang cmdr.Get("app.logger.level") => 'DEBUG',... ```

func GetBool

func GetBool(key string, defaultVal ...bool) bool

GetBool returns the bool value of an `Option` key. Such as: ```golang cmdr.GetBool("app.logger.enable", false) => true,... ```

func GetBoolP

func GetBoolP(prefix, key string, defaultVal ...bool) bool

GetBoolP returns the bool value of an `Option` key. Such as: ```golang cmdr.GetBoolP("app.logger", "enable", false) => true,... ```

func GetBoolR

func GetBoolR(key string, defaultVal ...bool) bool

GetBoolR returns the bool value of an `Option` key with WrapWithRxxtPrefix. Such as: ```golang cmdr.GetBoolR("logger.enable", false) => true,... ```

func GetBoolRP

func GetBoolRP(prefix, key string, defaultVal ...bool) bool

GetBoolRP returns the bool value of an `Option` key with WrapWithRxxtPrefix. Such as: ```golang cmdr.GetBoolRP("logger", "enable", false) => true,... ```

func GetComplex128

func GetComplex128(key string, defaultVal ...complex128) complex128

GetComplex128 returns the complex128 value of an `Option` key.

func GetComplex128P

func GetComplex128P(prefix, key string, defaultVal ...complex128) complex128

GetComplex128P returns the complex128 value of an `Option` key.

func GetComplex128R

func GetComplex128R(key string, defaultVal ...complex128) complex128

GetComplex128R returns the complex128 value of an `Option` key with WrapWithRxxtPrefix.

func GetComplex128RP

func GetComplex128RP(prefix, key string, defaultVal ...complex128) complex128

GetComplex128RP returns the complex128 value of an `Option` key with WrapWithRxxtPrefix.

func GetComplex64

func GetComplex64(key string, defaultVal ...complex64) complex64

GetComplex64 returns the complex64 value of an `Option` key.

func GetComplex64P

func GetComplex64P(prefix, key string, defaultVal ...complex64) complex64

GetComplex64P returns the complex64 value of an `Option` key.

func GetComplex64R

func GetComplex64R(key string, defaultVal ...complex64) complex64

GetComplex64R returns the complex64 value of an `Option` key with WrapWithRxxtPrefix.

func GetComplex64RP

func GetComplex64RP(prefix, key string, defaultVal ...complex64) complex64

GetComplex64RP returns the complex64 value of an `Option` key with WrapWithRxxtPrefix.

func GetDebugMode

func GetDebugMode() bool

GetDebugMode returns the flag value of `--debug`/`-D`

NOTE

log.GetDebugMode()/SetDebugMode() have higher universality

the flag value of `--debug` or `-D` is always stored in cmdr Option Store, so you can retrieved it by GetBoolR("debug") and set it by Set("debug", true). You could also set it with SetDebugMode(b bool).

func GetDebugModeHitCount

func GetDebugModeHitCount() int

GetDebugModeHitCount returns how many times `--debug`/`-D` specified

func GetDuration

func GetDuration(key string, defaultVal ...time.Duration) time.Duration

GetDuration returns the int slice value of an `Option` key.

func GetDurationP

func GetDurationP(prefix, key string, defaultVal ...time.Duration) time.Duration

GetDurationP returns the int slice value of an `Option` key.

func GetDurationR

func GetDurationR(key string, defaultVal ...time.Duration) time.Duration

GetDurationR returns the int slice value of an `Option` key.

func GetDurationRP

func GetDurationRP(prefix, key string, defaultVal ...time.Duration) time.Duration

GetDurationRP returns the int slice value of an `Option` key.

func GetFlagHitCount

func GetFlagHitCount(longName string) int

GetFlagHitCount return how manu times a top-level Flag was specified from command-line.

func GetFlagHitCountRecursively

func GetFlagHitCountRecursively(longName string) int

GetFlagHitCountRecursively return how manu times a Flag was specified from command-line. longName will be search recursively.

func GetFloat32

func GetFloat32(key string, defaultVal ...float32) float32

GetFloat32 returns the float32 value of an `Option` key.

func GetFloat32P

func GetFloat32P(prefix, key string, defaultVal ...float32) float32

GetFloat32P returns the float32 value of an `Option` key.

func GetFloat32R

func GetFloat32R(key string, defaultVal ...float32) float32

GetFloat32R returns the float32 value of an `Option` key with WrapWithRxxtPrefix.

func GetFloat32RP

func GetFloat32RP(prefix, key string, defaultVal ...float32) float32

GetFloat32RP returns the float32 value of an `Option` key with WrapWithRxxtPrefix.

func GetFloat64

func GetFloat64(key string, defaultVal ...float64) float64

GetFloat64 returns the float64 value of an `Option` key.

func GetFloat64P

func GetFloat64P(prefix, key string, defaultVal ...float64) float64

GetFloat64P returns the float64 value of an `Option` key.

func GetFloat64R

func GetFloat64R(key string, defaultVal ...float64) float64

GetFloat64R returns the float64 value of an `Option` key with WrapWithRxxtPrefix.

func GetFloat64RP

func GetFloat64RP(prefix, key string, defaultVal ...float64) float64

GetFloat64RP returns the float64 value of an `Option` key with WrapWithRxxtPrefix.

func GetHierarchyList

func GetHierarchyList() map[string]interface{}

GetHierarchyList returns the hierarchy data

func GetHitCountByDottedPath

func GetHitCountByDottedPath(dottedPath string) int

GetHitCountByDottedPath return how manu times a Flag or a Command was specified from command-line.

func GetInt

func GetInt(key string, defaultVal ...int) int

GetInt returns the int value of an `Option` key.

func GetInt64

func GetInt64(key string, defaultVal ...int64) int64

GetInt64 returns the int64 value of an `Option` key.

func GetInt64P

func GetInt64P(prefix, key string, defaultVal ...int64) int64

GetInt64P returns the int64 value of an `Option` key.

func GetInt64R

func GetInt64R(key string, defaultVal ...int64) int64

GetInt64R returns the int64 value of an `Option` key with WrapWithRxxtPrefix.

func GetInt64RP

func GetInt64RP(prefix, key string, defaultVal ...int64) int64

GetInt64RP returns the int64 value of an `Option` key with WrapWithRxxtPrefix.

func GetInt64Slice

func GetInt64Slice(key string, defaultVal ...int64) []int64

GetInt64Slice returns the int slice value of an `Option` key.

func GetInt64SliceP

func GetInt64SliceP(prefix, key string, defaultVal ...int64) []int64

GetInt64SliceP returns the int slice value of an `Option` key.

func GetInt64SliceR

func GetInt64SliceR(key string, defaultVal ...int64) []int64

GetInt64SliceR returns the int slice value of an `Option` key with WrapWithRxxtPrefix.

func GetInt64SliceRP

func GetInt64SliceRP(prefix, key string, defaultVal ...int64) []int64

GetInt64SliceRP returns the int slice value of an `Option` key with WrapWithRxxtPrefix.

func GetIntP

func GetIntP(prefix, key string, defaultVal ...int) int

GetIntP returns the int value of an `Option` key.

func GetIntR

func GetIntR(key string, defaultVal ...int) int

GetIntR returns the int value of an `Option` key with WrapWithRxxtPrefix.

func GetIntRP

func GetIntRP(prefix, key string, defaultVal ...int) int

GetIntRP returns the int value of an `Option` key with WrapWithRxxtPrefix.

func GetIntSlice

func GetIntSlice(key string, defaultVal ...int) []int

GetIntSlice returns the int slice value of an `Option` key.

func GetIntSliceP

func GetIntSliceP(prefix, key string, defaultVal ...int) []int

GetIntSliceP returns the int slice value of an `Option` key.

func GetIntSliceR

func GetIntSliceR(key string, defaultVal ...int) []int

GetIntSliceR returns the int slice value of an `Option` key with WrapWithRxxtPrefix.

func GetIntSliceRP

func GetIntSliceRP(prefix, key string, defaultVal ...int) []int

GetIntSliceRP returns the int slice value of an `Option` key with WrapWithRxxtPrefix.

func GetKibibytes

func GetKibibytes(key string, defaultVal ...uint64) uint64

GetKibibytes returns the uint64 value of an `Option` key.

kibibyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kibibyte is based 1024. That means: 1 KiB = 1k = 1024 bytes

See also: https://en.wikipedia.org/wiki/Kibibyte Its related word is kilobyte, refer to: https://en.wikipedia.org/wiki/Kilobyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetKibibytesP

func GetKibibytesP(prefix, key string, defaultVal ...uint64) uint64

GetKibibytesP returns the uint64 value of an `Option` key.

kibibyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kibibyte is based 1024. That means: 1 KiB = 1k = 1024 bytes

See also: https://en.wikipedia.org/wiki/Kibibyte Its related word is kilobyte, refer to: https://en.wikipedia.org/wiki/Kilobyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetKibibytesR

func GetKibibytesR(key string, defaultVal ...uint64) uint64

GetKibibytesR returns the uint64 value of an `Option` key with WrapWithRxxtPrefix.

kibibyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kibibyte is based 1024. That means: 1 KiB = 1k = 1024 bytes

See also: https://en.wikipedia.org/wiki/Kibibyte Its related word is kilobyte, refer to: https://en.wikipedia.org/wiki/Kilobyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetKibibytesRP

func GetKibibytesRP(prefix, key string, defaultVal ...uint64) uint64

GetKibibytesRP returns the uint64 value of an `Option` key with WrapWithRxxtPrefix.

kibibyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kibibyte is based 1024. That means: 1 KiB = 1k = 1024 bytes

See also: https://en.wikipedia.org/wiki/Kibibyte Its related word is kilobyte, refer to: https://en.wikipedia.org/wiki/Kilobyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetKilobytes

func GetKilobytes(key string, defaultVal ...uint64) uint64

GetKilobytes returns the uint64 value of an `Option` key.

kilobyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kilobyte is based 1000. That means: 1 KB = 1k = 1000 bytes

See also: https://en.wikipedia.org/wiki/Kilobyte Its related word is kibibyte, refer to: https://en.wikipedia.org/wiki/Kibibyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetKilobytesP

func GetKilobytesP(prefix, key string, defaultVal ...uint64) uint64

GetKilobytesP returns the uint64 value of an `Option` key.

kilobyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kilobyte is based 1000. That means: 1 KB = 1k = 1000 bytes

See also: https://en.wikipedia.org/wiki/Kilobyte Its related word is kibibyte, refer to: https://en.wikipedia.org/wiki/Kibibyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetKilobytesR

func GetKilobytesR(key string, defaultVal ...uint64) uint64

GetKilobytesR returns the uint64 value of an `Option` key with WrapWithRxxtPrefix.

kilobyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kilobyte is based 1000. That means: 1 KB = 1k = 1000 bytes

See also: https://en.wikipedia.org/wiki/Kilobyte Its related word is kibibyte, refer to: https://en.wikipedia.org/wiki/Kibibyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetKilobytesRP

func GetKilobytesRP(prefix, key string, defaultVal ...uint64) uint64

GetKilobytesRP returns the uint64 value of an `Option` key with WrapWithRxxtPrefix.

kilobyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kilobyte is based 1000. That means: 1 KB = 1k = 1000 bytes

See also: https://en.wikipedia.org/wiki/Kilobyte Its related word is kibibyte, refer to: https://en.wikipedia.org/wiki/Kibibyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func GetMap

func GetMap(key string) map[string]interface{}

GetMap an `Option` by key string, it returns a hierarchy map or nil

func GetMapR

func GetMapR(key string) map[string]interface{}

GetMapR an `Option` by key string with WrapWithRxxtPrefix, it returns a hierarchy map or nil

func GetNoColorMode

func GetNoColorMode() bool

GetNoColorMode return the flag value of `--no-color`/`-nc`

func GetNoColorModeHitCount

func GetNoColorModeHitCount() int

GetNoColorModeHitCount returns how many times `--no-color`/`-nc` specified

func GetPredefinedAlterLocations

func GetPredefinedAlterLocations() []string

GetPredefinedAlterLocations return the alternative searching locations. The alter config file will be merged into main config store after secondary config merged. The most different things are the alter config file can be written back when cmdr

func GetPredefinedLocations

func GetPredefinedLocations() []string

GetPredefinedLocations return the primary searching locations for loading the main config files. cmdr finds these location to create the main config store.

func GetQuietMode

func GetQuietMode() bool

GetQuietMode returns the flag value of `--quiet`/`-q`

func GetQuietModeHitCount

func GetQuietModeHitCount() int

GetQuietModeHitCount returns how many times `--quiet`/`-q` specified

func GetR

func GetR(key string) interface{}

GetR returns the generic value of an `Option` key with WrapWithRxxtPrefix. Such as: ```golang cmdr.GetR("logger.level") => 'DEBUG',... ```

func GetRemainArgs

func GetRemainArgs() []string

GetRemainArgs returns the remain arguments after command line parsed

func GetSecondaryLocations

func GetSecondaryLocations() []string

GetSecondaryLocations return the secondary searching locations, and these configs will be merged into main config store.

func GetSectionFrom

func GetSectionFrom(sectionKeyPath string, holder interface{}) (err error)

GetSectionFrom returns error while cannot yaml Marshal and Unmarshal `cmdr.GetSectionFrom(sectionKeyPath, &holder)` could load all sub-tree nodes from sectionKeyPath and transform them into holder structure, such as: ```go

type ServerConfig struct {
  Port int
  HttpMode int
  EnableTls bool
}
var serverConfig = new(ServerConfig)
cmdr.GetSectionFrom("server", &serverConfig)
assert serverConfig.Port == 7100

```

func GetStrictMode

func GetStrictMode() bool

GetStrictMode enables error when opt value missed. such as: xxx a b --prefix” => error: prefix opt has no value specified. xxx a b --prefix'/' => ok.

ENV: use `CMDR_APP_STRICT_MODE=true` to enable strict-mode. NOTE: `CMDR_APP_` prefix could be set by user (via: `EnvPrefix` && `RxxtPrefix`).

the flag value of `--strict-mode`.

func GetString

func GetString(key string, defaultVal ...string) string

GetString returns the string value of an `Option` key.

func GetStringNoExpand

func GetStringNoExpand(key string, defaultVal ...string) string

GetStringNoExpand returns the string value of an `Option` key.

func GetStringNoExpandP

func GetStringNoExpandP(prefix, key string, defaultVal ...string) string

GetStringNoExpandP returns the string value of an `Option` key.

func GetStringNoExpandR

func GetStringNoExpandR(key string, defaultVal ...string) string

GetStringNoExpandR returns the string value of an `Option` key with WrapWithRxxtPrefix.

func GetStringNoExpandRP

func GetStringNoExpandRP(prefix, key string, defaultVal ...string) string

GetStringNoExpandRP returns the string value of an `Option` key with WrapWithRxxtPrefix.

func GetStringP

func GetStringP(prefix, key string, defaultVal ...string) string

GetStringP returns the string value of an `Option` key.

func GetStringR

func GetStringR(key string, defaultVal ...string) string

GetStringR returns the string value of an `Option` key with WrapWithRxxtPrefix.

func GetStringRP

func GetStringRP(prefix, key string, defaultVal ...string) string

GetStringRP returns the string value of an `Option` key with WrapWithRxxtPrefix.

func GetStringSlice

func GetStringSlice(key string, defaultVal ...string) []string

GetStringSlice returns the string slice value of an `Option` key.

func GetStringSliceP

func GetStringSliceP(prefix, key string, defaultVal ...string) []string

GetStringSliceP returns the string slice value of an `Option` key.

func GetStringSliceR

func GetStringSliceR(key string, defaultVal ...string) []string

GetStringSliceR returns the string slice value of an `Option` key with WrapWithRxxtPrefix.

func GetStringSliceRP

func GetStringSliceRP(prefix, key string, defaultVal ...string) []string

GetStringSliceRP returns the string slice value of an `Option` key with WrapWithRxxtPrefix.

func GetTraceMode

func GetTraceMode() bool

GetTraceMode returns the flag value of `--trace`/`-tr`

NOTE

log.GetTraceMode()/SetTraceMode() have higher universality

the flag value of `--trace` or `-tr` is always stored in cmdr Option Store, so you can retrieved it by GetBoolR("trace") and set it by Set("trace", true). You could also set it with SetTraceMode(b bool).

The `--trace` is not enabled in default, so you have to add it manually:

import "github.com/hedzr/cmdr-addons/pkg/plugins/trace"
cmdr.Exec(buildRootCmd(),
    trace.WithTraceEnable(true),
)

func GetTraceModeHitCount

func GetTraceModeHitCount() int

GetTraceModeHitCount returns how many times `--trace`/`-tr` specified

func GetUint

func GetUint(key string, defaultVal ...uint) uint

GetUint returns the uint value of an `Option` key.

func GetUint64

func GetUint64(key string, defaultVal ...uint64) uint64

GetUint64 returns the uint64 value of an `Option` key.

func GetUint64P

func GetUint64P(prefix, key string, defaultVal ...uint64) uint64

GetUint64P returns the uint64 value of an `Option` key.

func GetUint64R

func GetUint64R(key string, defaultVal ...uint64) uint64

GetUint64R returns the uint64 value of an `Option` key with WrapWithRxxtPrefix.

func GetUint64RP

func GetUint64RP(prefix, key string, defaultVal ...uint64) uint64

GetUint64RP returns the uint64 value of an `Option` key with WrapWithRxxtPrefix.

func GetUint64Slice

func GetUint64Slice(key string, defaultVal ...uint64) []uint64

GetUint64Slice returns the int slice value of an `Option` key.

func GetUint64SliceP

func GetUint64SliceP(prefix, key string, defaultVal ...uint64) []uint64

GetUint64SliceP returns the int slice value of an `Option` key.

func GetUint64SliceR

func GetUint64SliceR(key string, defaultVal ...uint64) []uint64

GetUint64SliceR returns the int slice value of an `Option` key with WrapWithRxxtPrefix.

func GetUint64SliceRP

func GetUint64SliceRP(prefix, key string, defaultVal ...uint64) []uint64

GetUint64SliceRP returns the int slice value of an `Option` key with WrapWithRxxtPrefix.

func GetUintP

func GetUintP(prefix, key string, defaultVal ...uint) uint

GetUintP returns the uint value of an `Option` key.

func GetUintR

func GetUintR(key string, defaultVal ...uint) uint

GetUintR returns the uint value of an `Option` key with WrapWithRxxtPrefix.

func GetUintRP

func GetUintRP(prefix, key string, defaultVal ...uint) uint

GetUintRP returns the uint value of an `Option` key with WrapWithRxxtPrefix.

func GetUsedAlterConfigFile

func GetUsedAlterConfigFile() string

GetUsedAlterConfigFile returns the alternative config filename

func GetUsedConfigFile

func GetUsedConfigFile() string

GetUsedConfigFile returns the main config filename (generally it's `<appname>.yml`)

func GetUsedConfigSubDir

func GetUsedConfigSubDir() string

GetUsedConfigSubDir returns the sub-directory `conf.d` of config files. Note that it be always normalized now. Sometimes it might be empty string ("") if `conf.d` have not been found.

func GetUsedSecondaryConfigFile

func GetUsedSecondaryConfigFile() string

GetUsedSecondaryConfigFile returns the secondary config filename

func GetUsedSecondaryConfigSubDir

func GetUsedSecondaryConfigSubDir() string

GetUsedSecondaryConfigSubDir returns the subdirectory `conf.d` of secondary config files.

func GetUsingConfigFiles

func GetUsingConfigFiles() []string

GetUsingConfigFiles returns all loaded config files, includes the main config file and children in sub-directory `conf.d`.

func GetVerboseMode

func GetVerboseMode() bool

GetVerboseMode returns the flag value of `--verbose`/`-v`

func GetVerboseModeHitCount

func GetVerboseModeHitCount() int

GetVerboseModeHitCount returns how many times `--verbose`/`-v` specified

func GetWatchingConfigFiles

func GetWatchingConfigFiles() []string

GetWatchingConfigFiles returns all config files being watched.

func HasKey

func HasKey(key string) (ok bool)

HasKey detects whether a key exists in cmdr options store or not

func InDebugging

func InDebugging() bool

InDebugging return the status if cmdr was built with debug mode / or the app running under a debugger attached.

To enable the debugger attached mode for cmdr, run `go build` with `-tags=delve` options. eg:

go run -tags=delve ./cli
go build -tags=delve -o my-app ./cli

For Goland, you can enable this under 'Run/Debug Configurations', by adding the following into 'Go tool arguments:'

-tags=delve

InDebugging() is a synonym to IsDebuggerAttached().

NOTE that `isdelve` algor is from https://stackoverflow.com/questions/47879070/how-can-i-see-if-the-goland-debugger-is-running-in-the-program

noinspection GoBoolExpressions

func InDevelopingTime

func InDevelopingTime() (status bool)

InDevelopingTime detects whether is in developing time.

If the main program has been built as a executable binary, we would assumed which is not in developing time. If GetDebugMode() is true, that's in developing time too.

func InDockerEnv

func InDockerEnv() (status bool)

InDockerEnv detects whether is running within docker container environment.

func InTesting

func InTesting() bool

InTesting detects whether is running under go test mode

func InvokeCommand

func InvokeCommand(dottedCommandPath string, extraArgs ...string) (err error)

InvokeCommand invokes a sub-command internally.

func IsDebuggerAttached

func IsDebuggerAttached() bool

IsDebuggerAttached return the status if cmdr was built with debug mode / or the app running under a debugger attached.

To enable the debugger attached mode for cmdr, run `go build` with `-tags=delve` options. eg:

go run -tags=delve ./cli
go build -tags=delve -o my-app ./cli

For Goland, you can enable this under 'Run/Debug Configurations', by adding the following into 'Go tool arguments:'

-tags=delve

IsDebuggerAttached() is a synonym to InDebugging().

NOTE that `isdelve` algor is from https://stackoverflow.com/questions/47879070/how-can-i-see-if-the-goland-debugger-is-running-in-the-program

noinspection GoBoolExpressions

func IsZero

func IsZero(v reflect.Value) bool

IsZero reports whether v is the zero value for its type. It panics if the argument is invalid.

func LoadConfigFile

func LoadConfigFile(file string) (mainFile, subDir string, err error)

LoadConfigFile loads a yaml config file and merge the settings into `rxxtOptions` and load files in the `conf.d` child directory too.

func MergeWith

func MergeWith(m map[string]interface{}) (err error)

MergeWith will merge a map recursive. You could merge a yaml/json/toml options into cmdr Hierarchy Options.

func NewLoggerConfig

func NewLoggerConfig() *log.LoggerConfig

NewLoggerConfig returns a default LoggerConfig

func NewLoggerConfigWith

func NewLoggerConfigWith(enabled bool, backend, level string) *log.LoggerConfig

NewLoggerConfigWith returns a default LoggerConfig

func RemoveOnConfigLoadedListener

func RemoveOnConfigLoadedListener(c ConfigReloaded)

RemoveOnConfigLoadedListener remove an functor on config loaded and merged

func ResetOptions

func ResetOptions()

ResetOptions to reset the exists `Options`, so that you could follow a `LoadConfigFile()` with it.

func RestoreCheckpoint

func RestoreCheckpoint(n ...int) (err error)

RestoreCheckpoint restore 1 or n checkpoint(s) from snapshots history. see also SaveCheckpoint

func SaveAsJSON

func SaveAsJSON(filename string) (err error)

SaveAsJSON to Save all config entries as a json file

func SaveAsToml

func SaveAsToml(filename string) (err error)

SaveAsToml to Save all config entries as a toml file

func SaveAsYaml

func SaveAsYaml(filename string) (err error)

SaveAsYaml to Save all config entries as a yaml file

func SaveCheckpoint

func SaveCheckpoint() (err error)

SaveCheckpoint make a snapshot of the current Option Store

You may ResetOptions after SaveCheckpoint:

func x(aMap map[string]interface{}){
    defer cmdr.RestoreCheckpoint()
    cmdr.SaveCheckpoint()
    cmdr.ResetOptions()
    cmdr.MergeWith(map[string]interface{}{
      "app": map[string]interface{}{
        conf.AppName: map[string]interface{}{
          "a-map": aMap,
        }
      }
    }
    cmdr.SaveAsYaml("a-setting.yml")
}

func SaveObjAsToml

func SaveObjAsToml(obj interface{}, filename string) (err error)

SaveObjAsToml to Save an object as a toml file

func Set

func Set(key string, val interface{})

Set set the value of an `Option` key (with prefix auto-wrap). The key MUST not have an `app` prefix. eg:

cmdr.Set("logger.level", "DEBUG")
cmdr.Set("ms.tags.port", 8500)
...
cmdr.Set("debug", true)
cmdr.GetBool("app.debug") => true

func SetDebugMode

func SetDebugMode(b bool)

SetDebugMode setup the debug mode status in Option Store

func SetLogger

func SetLogger(l log.Logger)

SetLogger transfer an instance into log package-level value

func SetNx

func SetNx(key string, val interface{})

SetNx but without prefix auto-wrapped. `rxxtPrefix` is a string slice to define the prefix string array, default is ["app"]. So, cmdr.Set("debug", true) will put a real entry with (`debug`, true).

func SetOnConfigLoadedListener

func SetOnConfigLoadedListener(c ConfigReloaded, enabled bool)

SetOnConfigLoadedListener enable/disable an functor on config loaded and merged

func SetRaw

func SetRaw(key string, val interface{})

SetRaw but without prefix auto-wrapped. So, cmdr.SetRaw("debug", true) will put a real entry with (`debug`, true).

cmdr.Set("debug", true)
cmdr.GetBool("debug") => true

func SetTraceMode

func SetTraceMode(b bool)

SetTraceMode setup the tracing mode status in Option Store

func SignalQuitSignal

func SignalQuitSignal()

SignalQuitSignal post a SIGQUIT signal to the current process

func SignalTermSignal

func SignalTermSignal()

SignalTermSignal post a SIGTERM signal to the current process

func SignalToSelf

func SignalToSelf(sig os.Signal) (err error)

SignalToSelf trigger the sig signal to the current process

func ToBool

func ToBool(val interface{}, defaultVal ...bool) (ret bool)

ToBool translate a value to boolean

func TrapSignals

func TrapSignals(onTrapped func(s os.Signal), signals ...os.Signal) (waiter func())

TrapSignals is a helper for simplify your infinite loop codes.

Usage

 func enteringLoop() {
	  waiter := cmdr.TrapSignals(func(s os.Signal) {
	    cmdr.Logger.Debugf("receive signal '%v' in onTrapped()", s)
	  })
	  go waiter()
 }

func TrapSignalsEnh

func TrapSignalsEnh(done chan bool, onTrapped func(s os.Signal), signals ...os.Signal) (waiter func())

TrapSignalsEnh is a helper for simplify your infinite loop codes.

Usage

 func enteringLoop() {
   done := make(chan bool, 1)
   go func(done chan bool){
      // your main serve loop
      done <- true   // to end the TrapSignalsEnh waiter by manually, instead of os signals caught.
   }(done)
	  waiter := cmdr.TrapSignalsEnh(done, func(s os.Signal) {
	    cmdr.Logger.Debugf("receive signal '%v' in onTrapped()", s)
	  })
	  go waiter()
 }

func WalkAllCommands

func WalkAllCommands(walk func(cmd *Command, index, level int) (err error)) (err error)

WalkAllCommands loops for all commands, starting from root.

func WrapWithRxxtPrefix

func WrapWithRxxtPrefix(key string) string

WrapWithRxxtPrefix wrap an key with [RxxtPrefix], for [GetXxx(key)] and [GetXxxP(prefix,key)]

Types

type BaseOpt

type BaseOpt struct {
	Name string `yaml:"name,omitempty" json:"name,omitempty"`
	// Short rune. short option/command name.
	// single char. example for flag: "a" -> "-a"
	Short string `yaml:"short-name,omitempty" json:"short-name,omitempty"`
	// Full full/long option/command name.
	// word string. example for flag: "addr" -> "--addr"
	Full string `yaml:"title,omitempty" json:"title,omitempty"`
	// Aliases are the more synonyms
	Aliases []string `yaml:"aliases,flow,omitempty" json:"aliases,flow,omitempty"`
	// Group group name
	Group string `yaml:"group,omitempty" json:"group,omitempty"`

	Description     string `yaml:"desc,omitempty" json:"desc,omitempty"`
	LongDescription string `yaml:"long-desc,omitempty" json:"long-desc,omitempty"`
	Examples        string `yaml:"examples,omitempty" json:"examples,omitempty"`
	Hidden          bool   `yaml:"hidden,omitempty" json:"hidden,omitempty"`

	// Deprecated is a version string just like '0.5.9' or 'v0.5.9', that means this command/flag was/will be deprecated since `v0.5.9`.
	Deprecated string `yaml:"deprecated,omitempty" json:"deprecated,omitempty"`

	// Action is callback for the last recognized command/sub-command.
	// return: ErrShouldBeStopException will break the following flow and exit right now
	// cmd 是 flag 被识别时已经得到的子命令
	Action Handler `yaml:"-" json:"-"`
	// contains filtered or unexported fields
}

BaseOpt is base of `Command`, `Flag`

func (*BaseOpt) GetDescZsh

func (s *BaseOpt) GetDescZsh() (desc string)

GetDescZsh temp

func (*BaseOpt) GetLongTitleNamesArray

func (s *BaseOpt) GetLongTitleNamesArray() []string

GetLongTitleNamesArray returns long name and aliases as an array

func (*BaseOpt) GetShortTitleNamesArray

func (s *BaseOpt) GetShortTitleNamesArray() []string

GetShortTitleNamesArray returns short name as an array

func (*BaseOpt) GetTitleName

func (s *BaseOpt) GetTitleName() string

GetTitleName returns name/full/short string

func (*BaseOpt) GetTitleNames

func (s *BaseOpt) GetTitleNames() string

GetTitleNames return the joint string of short,full,aliases names

func (*BaseOpt) GetTitleNamesArray

func (s *BaseOpt) GetTitleNamesArray() []string

GetTitleNamesArray returns short,full,aliases names

func (*BaseOpt) GetTitleNamesArrayMainly

func (s *BaseOpt) GetTitleNamesArrayMainly() []string

GetTitleNamesArrayMainly returns short,full names

func (*BaseOpt) GetTitleNamesBy

func (s *BaseOpt) GetTitleNamesBy(delimChar string) string

GetTitleNamesBy returns the joint string of short,full,aliases names

func (*BaseOpt) GetTitleZshNames

func (s *BaseOpt) GetTitleZshNames() string

GetTitleZshNames temp

func (*BaseOpt) GetTitleZshNamesBy

func (s *BaseOpt) GetTitleZshNamesBy(delimChar string) (str string)

GetTitleZshNamesBy temp

func (*BaseOpt) HasParent

func (s *BaseOpt) HasParent() bool

HasParent detects whether owner is available or not

type Command

type Command struct {
	BaseOpt `yaml:",inline"`

	Flags []*Flag `yaml:"flags,omitempty" json:"flags,omitempty"`

	SubCommands []*Command `yaml:"subcmds,omitempty" json:"subcmds,omitempty"`

	// return: ErrShouldBeStopException will break the following flow and exit right now
	PreAction Handler `yaml:"-" json:"-"`
	// PostAction will be run after Action() invoked.
	PostAction Invoker `yaml:"-" json:"-"`
	// TailPlaceHolder contains the description text of positional
	// arguments of a command.
	// It will be shown at tail of command usages line. Suppose there's
	// a TailPlaceHolder  with"<host-fqdn> <ipv4/6>", they will be
	// painted in help screen just like:
	//
	//     austr dns add <host-fqdn> <ipv4/6> [Options] [Parent/Global Options]
	//
	TailPlaceHolder string `yaml:"tail-placeholder,omitempty" json:"tail-placeholder,omitempty"`

	// Invoke is a space separated string which takes Command (name) and extra
	// remain args to be invoked.
	// It invokes a command from the command tree in this app.
	// Invoke field is available for
	Invoke string `yaml:"invoke,omitempty" json:"invoke,omitempty"`
	// InvokeProc is just for cmdr aliases commands
	// invoke the external commands (via: executable)
	InvokeProc string `yaml:"invoke-proc,omitempty" json:"invoke-proc,omitempty"`
	// InvokeShell is just for cmdr aliases commands
	// invoke the external commands (via: shell)
	InvokeShell string `yaml:"invoke-sh,omitempty" json:"invoke-sh,omitempty"`
	// Shell is just for cmdr aliases commands
	// invoke a command under this shell, or /usr/bin/env bash|zsh|...
	Shell string `yaml:"shell,omitempty" json:"shell,omitempty"`
	// contains filtered or unexported fields
}

Command holds the structure of commands and sub-commands

func DottedPathToCommand

func DottedPathToCommand(dottedPath string, anyCmd *Command) (cc *Command)

DottedPathToCommand searches the matched Command with the specified dotted-path. The searching will start from root if anyCmd is nil.

func FindSubCommand

func FindSubCommand(longName string, cmd *Command) (res *Command)

FindSubCommand find sub-command with `longName` from `cmd` if cmd == nil: finding from root command

func FindSubCommandRecursive

func FindSubCommandRecursive(longName string, cmd *Command) (res *Command)

FindSubCommandRecursive find sub-command with `longName` from `cmd` recursively if cmd == nil: finding from root command

func Match

func Match(inputCommandlineWithoutArg0 string, opts ...ExecOption) (last *Command, err error)

Match try parsing the input command-line, the result is the last hit *Command.

func (*Command) Delete

func (c *Command) Delete()

Delete removes myself from the command hierarchy system.

func (*Command) FindFlag

func (c *Command) FindFlag(longName string) (res *Flag)

FindFlag find flag with `longName` from `cmd`

func (*Command) FindFlagRecursive

func (c *Command) FindFlagRecursive(longName string) (res *Flag)

FindFlagRecursive find flag with `longName` from `cmd` recursively

func (*Command) FindSubCommand

func (c *Command) FindSubCommand(longName string) (res *Command)

FindSubCommand find sub-command with `longName` from `cmd`

func (*Command) FindSubCommandRecursive

func (c *Command) FindSubCommandRecursive(longName string) (res *Command)

FindSubCommandRecursive find sub-command with `longName` from `cmd` recursively

func (*Command) GetDottedNamePath

func (c *Command) GetDottedNamePath() string

GetDottedNamePath return the dotted key path of this command in the options store. For example, the returned string just like: 'server.start'. NOTE that there is no OptiontPrefixes in this key path. For more information about Option Prefix, refer to WithOptionsPrefix

func (*Command) GetExpandableNames

func (c *Command) GetExpandableNames() string

GetExpandableNames returns the names comma splitted string.

func (*Command) GetExpandableNamesArray

func (c *Command) GetExpandableNamesArray() []string

GetExpandableNamesArray returns the names array of command, includes short name and long name.

func (*Command) GetHitStr

func (c *Command) GetHitStr() string

GetHitStr returns the matched command string

func (*Command) GetName

func (c *Command) GetName() string

GetName returns the name of a `Command`.

func (*Command) GetOwner

func (c *Command) GetOwner() *Command

GetOwner returns the parent command object

func (*Command) GetParentName

func (c *Command) GetParentName() string

GetParentName returns the owner command name

func (*Command) GetQuotedGroupName

func (c *Command) GetQuotedGroupName() string

GetQuotedGroupName returns the group name quoted string.

func (*Command) GetRoot

func (c *Command) GetRoot() *RootCommand

GetRoot returns the `RootCommand`

func (*Command) GetSubCommandNamesBy

func (c *Command) GetSubCommandNamesBy(delimChar string) string

GetSubCommandNamesBy returns the joint string of subcommands

func (*Command) GetTriggeredTimes

func (c *Command) GetTriggeredTimes() int

GetTriggeredTimes returns the matched times

func (*Command) IsRoot

func (c *Command) IsRoot() bool

IsRoot returns true if this command is a RootCommand

func (*Command) PrintBuildInfo

func (c *Command) PrintBuildInfo()

PrintBuildInfo print building information

func (*Command) PrintHelp

func (c *Command) PrintHelp(justFlags bool)

PrintHelp prints help screen

func (*Command) PrintVersion

func (c *Command) PrintVersion()

PrintVersion prints versions information

type ConfigReloaded

type ConfigReloaded interface {
	OnConfigReloaded()
}

ConfigReloaded for config reloaded

type Copier

type Copier interface {
	SetIgnoreNames(ignoreNames ...string) Copier
	SetEachFieldAlways(b bool) Copier
	Copy(toValue interface{}, fromValue interface{}, ignoreNames ...string) (err error)
}

Copier interface Copier is based on from github.com/jinzhu/copier

type ErrorForCmdr

type ErrorForCmdr struct {
	// Inner     error
	// Msg       string
	Ignorable bool
	// contains filtered or unexported fields
}

ErrorForCmdr structure

func (*ErrorForCmdr) As

func (w *ErrorForCmdr) As(target interface{}) bool

As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.

func (*ErrorForCmdr) Attach

func (w *ErrorForCmdr) Attach(errs ...error)

Attach appends errs. For ErrorForCmdr, only one last error will be kept.

func (*ErrorForCmdr) Cause

func (w *ErrorForCmdr) Cause() error

Cause returns the underlying cause of the error recursively, if possible.

func (*ErrorForCmdr) Error

func (w *ErrorForCmdr) Error() string

func (*ErrorForCmdr) FormatNew

func (w *ErrorForCmdr) FormatNew(ignorable bool, livedArgs ...interface{}) *errors.WithStackInfo

FormatNew creates a new error object based on this error template 'w'.

Example:

errTmpl1001 := BUG1001.NewTemplate("something is wrong %v")
err4 := errTmpl1001.FormatNew("ok").Attach(errBug1)
fmt.Println(err4)
fmt.Printf("%+v\n", err4)

func (*ErrorForCmdr) Is

func (w *ErrorForCmdr) Is(target error) bool

Is reports whether any error in err's chain matches target.

func (*ErrorForCmdr) Unwrap

func (w *ErrorForCmdr) Unwrap() error

Unwrap returns the result of calling the Unwrap method on err, if err's type contains an Unwrap method returning error. Otherwise, Unwrap returns nil.

type ExecOption

type ExecOption func(w *ExecWorker)

ExecOption is the functional option for Exec()

func WithAfterArgsParsed

func WithAfterArgsParsed(hookFunc Handler) ExecOption

WithAfterArgsParsed sets a callback point after command-line args parsed by cmdr internal exec().

Your callback func will be invoked before invoking the matched command `cmd`. At this time, all command-line args parsed and a command found.

If program was launched with empty or wrong arguments, your callback func won't be triggered.

When empty argument or `--help` found, cmdr will display help screen. To customize it see also cmdr.WithCustomShowVersion and cmdr.WithCustomShowBuildInfo.

When any wrong/warn arguments found, cmdr will display some tip messages. To customize it see also cmdr.WithUnknownOptionHandler.

func WithAlterLocations

func WithAlterLocations(locations ...string) ExecOption

WithAlterLocations sets the alter config file locations.

Default is:

alterLocations: []string{
    "/ci/etc/$APPNAME/alter/$APPNAME.yml",
    "/etc/$APPNAME/alter/$APPNAME.yml",
    "/usr/local/etc/$APPNAME/alter/$APPNAME.yml",
    "./bin/$APPNAME.yml",              // for developer, current bin directory
    "/var/lib/$APPNAME/.$APPNAME.yml", //
    "$THIS/.$APPNAME.yml",             // executable's directory
},

NOTE that just one config file will be loaded, the child `conf.d` folder not supports.

cmdr will SAVE the changes in this alter config file automatically once loaded.

func WithAutomaticEnvHooks

func WithAutomaticEnvHooks(hook HookOptsFunc) ExecOption

WithAutomaticEnvHooks sets the hook after building automatic environment.

At this point, you could override the option default values.

func WithBuiltinCommands

func WithBuiltinCommands(versionsCmds, helpCmds, verboseCmds, generateCmds, generalCmdrCmds bool) ExecOption

WithBuiltinCommands enables/disables those builtin predefined commands. Such as:

• versionsCmds / EnableVersionCommands supports injecting the default `--version` flags and commands
• helpCmds / EnableHelpCommands supports injecting the default `--help` flags and commands
• verboseCmds / EnableVerboseCommands supports injecting the default `--verbose` flags and commands
• generalCmdrCmds / EnableCmdrCommands support these flags: `--strict-mode`, `--no-env-overrides`, and `--no-color`
• generateCmds / EnableGenerateCommands supports injecting the default `generate` commands and sub-commands

func WithCommandSystemCustomizing

func WithCommandSystemCustomizing(customizer HookFunc) ExecOption

WithCommandSystemCustomizing provides a shortcut to allow plugin/addon can customize the whole command/sub-command hierarchy structure.

For example, suppose you're planning to hide the 'generate' internal command from help screen:

opt := cmdr.WithCommandSystemCustomizing(
  func(root *cmdr.RootCommand, args []string) {
    root.FindSubCommand("generate").Delete()
  })
opts := append(opts, opt)
err := cmdr.Exec(buildMyCommands(), opts...)

And, you may attach more sub-commands into the current command system from your plugin/addon:

func WithColorTableCommand(dottedCommand ...string) cmdr.ExecOption {
    return cmdr.WithCommandSystemCustomizing(
      func(root *cmdr.RootCommand, args []string) {
        cmd := &root.Command
        for _, d := range dottedCommand {
          cmd = cmdr.DottedPathToCommand(d, cmd)
          break
        }
        rr := cmdr.NewCmdFrom(cmd)
        addTo(rr, cmdr.RootFrom(root))
      })
}

func addTo(rr cmdr.OptCmd, root *cmdr.RootCmdOpt) {
    c := cmdr.NewSubCmd()

    c.Titles("color-table", "ct").
        Description("print shell escape sequence table", "").
        Group(cmdr.SysMgmtGroup).
        Hidden(hidden).
        Action(printColorTable).
        AttachTo(rr)
    //...
}

func WithConfigFileLoadingHooks

func WithConfigFileLoadingHooks(before, after HookFunc) ExecOption

WithConfigFileLoadingHooks adds the hook function to the front and back of trying to load config files.

These two hooks always are triggered whatever WithNoLoadConfigFiles is enabled or not.

func WithConfigLoadedListener

func WithConfigLoadedListener(c ConfigReloaded) ExecOption

WithConfigLoadedListener adds a functor on config loaded and merged

func WithConfigSubDirAutoName

func WithConfigSubDirAutoName(folderName string) ExecOption

WithConfigSubDirAutoName specify an alternate folder name instead `conf.d`.

By default, cmdr watches all files in the sub-directory `conf.d` of which folder contains the main config file.

func WithCustomShowBuildInfo

func WithCustomShowBuildInfo(fn func()) ExecOption

WithCustomShowBuildInfo supports your `ShowBuildInfo()` instead of internal `showBuildInfo()`

func WithCustomShowVersion

func WithCustomShowVersion(fn func()) ExecOption

WithCustomShowVersion supports your `ShowVersion()` instead of internal `showVersion()`

func WithEnvPrefix

func WithEnvPrefix(prefix ...string) ExecOption

WithEnvPrefix sets the environment variable text prefixes. cmdr will lookup envvars for a key. Default env-prefix is array ["CMDR"], ie 'CMDR_'

func WithEnvVarMap

func WithEnvVarMap(varToValue map[string]func() string) ExecOption

WithEnvVarMap adds a (envvar-name, value) map, which will be applied to string option value, string-slice option values, .... For example, you could define a key-value entry in your `<app>.yml` file:

app:
  test-value: "$THIS/$APPNAME.yml"
  home-dir: "$HOME"

it will be expanded by mapping to OS environment and this map (WithEnvVarMap). That is, $THIS will be expanded to the directory path of this executable, $APPNAME to the app name. And of course, $HOME will be mapped to os home directory path.

func WithExtensionsLocations

func WithExtensionsLocations(locations ...string) ExecOption

WithExtensionsLocations sets the extension locations.

A extension is an executable (shell scripts, binary executable, ,,,).

Default locations are:

    []string{
		   "./ci/local/share/$APPNAME/ext",
		   "$HOME/.local/share/$APPNAME/ext",
		   "$HOME/.$APPNAME/ext",
		   "/usr/local/share/$APPNAME/ext",
		   "/usr/share/$APPNAME/ext",
    },

See also internalResetWorkerNoLock()

func WithGlobalPostActions

func WithGlobalPostActions(fns ...Invoker) ExecOption

WithGlobalPostActions adds the post-action for each command invoked

func WithGlobalPreActions

func WithGlobalPreActions(fns ...Handler) ExecOption

WithGlobalPreActions adds the pre-action for every command invoking

func WithHelpPainter

func WithHelpPainter(painter Painter) ExecOption

WithHelpPainter allows to change the behavior and facade of help screen.

func WithHelpScreenHooks

func WithHelpScreenHooks(before, after HookHelpScreenFunc) ExecOption

WithHelpScreenHooks adds the hook function to the front and back of printing help screen

func WithHelpTabStop

func WithHelpTabStop(tabStop int) ExecOption

WithHelpTabStop sets the tab-stop position in the help screen Default tabstop is 48

Deprecated since v1.7.8 because the tab-stop position will be autosize from then on.

func WithHelpTailLine

func WithHelpTailLine(line string) ExecOption

WithHelpTailLine setup the tail line in help screen

Default line is:

"\nType '-h' or '--help' to get command help screen."

func WithIgnoreWrongEnumValue

func WithIgnoreWrongEnumValue(ignored bool) ExecOption

WithIgnoreWrongEnumValue will be put into `cmdrError.Ignorable` while wrong enumerable value found in parsing command-line options. The default is true.

Main program might decide whether it's a warning or error.

See also

[Flag.ValidArgs]

func WithInternalOutputStreams

func WithInternalOutputStreams(out, err *bufio.Writer) ExecOption

WithInternalOutputStreams sets the internal output streams for debugging

func WithLogex

func WithLogex(lvl Level, opts ...logex.Option) ExecOption

WithLogex enables github.com/hedzr/logex integration

Deprecated since v1.7.7, replace with WithLogx().

func WithLogexPrefix

func WithLogexPrefix(prefix string) ExecOption

WithLogexPrefix specify a prefix string PS.

In cmdr options store, we will load the logging options under this key path:

app:
  logger:
    level:  DEBUG            # panic, fatal, error, warn, info, debug, trace, off
    format: text             # text, json, logfmt
    target: default          # default, todo: journal

As showing above, the default prefix is "logger". You can replace it with yours, via WithLogexPrefix(). For example, when you compose WithLogexPrefix("logging"), the following entries would be applied:

app:
  logging:
    level:  DEBUG
    format:
    target:

Deprecated since v1.7.6, replace with WithLogx().

func WithLogexSkipFrames

func WithLogexSkipFrames(skipFrames int) ExecOption

WithLogexSkipFrames specify the skip frames to lookup the caller

Deprecated since v1.7.6, replace with WithLogx().

func WithLogx

func WithLogx(logger log.Logger) ExecOption

WithLogx enables github.com/hedzr/logex,log integration

Sample 1:

WithLogx(log.NewDummyLogger()),	// import "github.com/hedzr/log"
WithLogx(log.NewStdLogger()),	// import "github.com/hedzr/log"
WithLogx(logrus.New()),		// import "github.com/hedzr/logex/logx/logrus"
WithLogx(sugar.New()),		// import "github.com/hedzr/logex/logx/zap/sugar"
WithLogx(zap.New()),			// import "github.com/hedzr/logex/logx/zap"

Sample 2:

WithLogx(build.New(loggerConfig)),	// import "github.com/hedzr/logex/build"
WithLogx(build.New(build.NewLoggerConfigWith(true, "zap", "debug")),

func WithLogxShort

func WithLogxShort(enabled bool, backend, level string) ExecOption

WithLogxShort enables github.com/hedzr/logex,log integration

func WithNoColor

func WithNoColor(b bool) ExecOption

WithNoColor make console outputs plain and without ANSI escape colors

Since v1.6.2+

func WithNoCommandAction

func WithNoCommandAction(b bool) ExecOption

WithNoCommandAction do NOT run the action of the matched command.

func WithNoDefaultHelpScreen

func WithNoDefaultHelpScreen(b bool) ExecOption

WithNoDefaultHelpScreen true to disable printing help screen if without any arguments

func WithNoEnvOverrides

func WithNoEnvOverrides(b bool) ExecOption

WithNoEnvOverrides enables the internal no-env-overrides mode

Since v1.6.2+

In this mode, cmdr do NOT find and transfer equivalent envvar value into cmdr options store.

func WithNoLoadConfigFiles

func WithNoLoadConfigFiles(b bool) ExecOption

WithNoLoadConfigFiles true means no loading config files

func WithNoWatchConfigFiles

func WithNoWatchConfigFiles(b bool) ExecOption

WithNoWatchConfigFiles true means no watching the config files

func WithOnPassThruCharHit

func WithOnPassThruCharHit(fn func(parsed *Command, switchChar string, args []string) (err error)) ExecOption

WithOnPassThruCharHit handle the passthrough char(s) (i.e. '--') matched For example, type `bin/fluent mx -d -- --help` will trigger this callback at the 2nd flag '--'.

func WithOnSwitchCharHit

func WithOnSwitchCharHit(fn func(parsed *Command, switchChar string, args []string) (err error)) ExecOption

WithOnSwitchCharHit handle the exact single switch-char (such as '-', '/', '~') matched. For example, type `bin/fluent mx -d - --help` will trigger this callback at the 2nd flag '-'.

func WithOptionMergeModifying

func WithOptionMergeModifying(onMergingSet func(keyPath string, value, oldVal interface{})) ExecOption

WithOptionMergeModifying adds a callback which invoked on new configurations was merging into, typically on loading the modified external config file(s). NOTE that MergeWith(...) can make it triggered too. A onMergingSet callback will be enabled after first loaded any external configuration files and environment variables merged.

func WithOptionModifying

func WithOptionModifying(onOptionSet func(keyPath string, value, oldVal interface{})) ExecOption

WithOptionModifying adds a callback which invoked at each time any option was modified. It will be triggered after any external config files first loaded and the env variables had been merged.

func WithOptionsPrefix

func WithOptionsPrefix(prefix ...string) ExecOption

WithOptionsPrefix create a top-level namespace, which contains all normalized `Flag`s. =WithRxxtPrefix Default Options Prefix is array ["app"], ie 'app.xxx'

func WithPagerEnabled

func WithPagerEnabled(enabled ...bool) ExecOption

WithPagerEnabled transfer cmdr stdout to OS pager. The environment variable `PAGER` will be checkout, otherwise `less`.

NOTICE ONLY the outputs of cmdr (such as help screen) will be paged.

func WithPluginLocations

func WithPluginLocations(locations ...string) ExecOption

WithPluginLocations sets the addon locations.

An addon is a golang plugin for cmdr.

Default locations are:

    []string{
		   "./ci/local/share/$APPNAME/addons",
		   "$HOME/.local/share/$APPNAME/addons",
		   "$HOME/.$APPNAME/addons",
		   "/usr/local/share/$APPNAME/addons",
		   "/usr/share/$APPNAME/addons",
    },

See also internalResetWorkerNoLock()

func WithPredefinedLocations

func WithPredefinedLocations(locations ...string) ExecOption

WithPredefinedLocations sets the main config file locations.

Default is:

[]string{
    "./ci/etc/$APPNAME/$APPNAME.yml",       // for developer
    "/etc/$APPNAME/$APPNAME.yml",           // regular location
    "/usr/local/etc/$APPNAME/$APPNAME.yml", // regular macOS HomeBrew location
    "/opt/etc/$APPNAME/$APPNAME.yml",       // regular location
    "/var/lib/etc/$APPNAME/$APPNAME.yml",   // regular location
    "$HOME/.config/$APPNAME/$APPNAME.yml",  // per user
    "$THIS/$APPNAME.yml",                   // executable's directory
    "$APPNAME.yml",                         // current directory
},

See also internalResetWorkerNoLock()

func WithRxxtPrefix

func WithRxxtPrefix(prefix ...string) ExecOption

WithRxxtPrefix create a top-level namespace, which contains all normalized `Flag`s. cmdr will lookup envvars for a key. Default Options Prefix is array ["app"], ie 'app.xxx'

func WithSearchAlterConfigFiles

func WithSearchAlterConfigFiles(b bool) ExecOption

WithSearchAlterConfigFiles adds CURR_DIR/.<appname>.yml and CURR_DIR/.<appname>/*.yml to the assumed config files and folders

func WithSecondaryLocations

func WithSecondaryLocations(locations ...string) ExecOption

WithSecondaryLocations sets the secondary config file locations.

Default is:

secondaryLocations: []string{
    "/ci/etc/$APPNAME/conf/$APPNAME.yml",
    "/etc/$APPNAME/conf/$APPNAME.yml",
    "/usr/local/etc/$APPNAME/conf/$APPNAME.yml",
    "$HOME/.$APPNAME/$APPNAME.yml", // ext location per user
},

The child `conf.d` folder will be loaded too.

func WithSimilarThreshold

func WithSimilarThreshold(similarThreshold float64) ExecOption

WithSimilarThreshold defines a threshold for command/option similar detector. Default threshold is 0.6666666666666666. See also JaroWinklerDistance

func WithStrictMode

func WithStrictMode(b bool) ExecOption

WithStrictMode enables the internal strict mode

Since v1.6.2+

In this mode, any warnings will be treat as an error and cause app fatal exit.

In normal mode, these cases are assumed as warnings: - flag name not found - command or sub-command name not found - value extracting failed - ...

func WithToggleGroupChoicerNewStyle

func WithToggleGroupChoicerNewStyle(style string, trueChoicer, falseChoicer string) ExecOption

WithToggleGroupChoicerNewStyle enables customizable choicer characters with your own style name.

For `ToggleGroup Choicer` and its style, see also: https://github.com/hedzr/cmdr/issues/1#issuecomment-968247546

func WithToggleGroupChoicerStyle

func WithToggleGroupChoicerStyle(style string) ExecOption

WithToggleGroupChoicerStyle allows user-defined choicer style.

The valid styles are: hexagon, triangle-right.

For `ToggleGroup Choicer` and its style, see also: https://github.com/hedzr/cmdr/issues/1#issuecomment-968247546

func WithUnhandledErrorHandler

func WithUnhandledErrorHandler(handler UnhandledErrorHandler) ExecOption

WithUnhandledErrorHandler handle the panics or exceptions generally

func WithUnknownOptionHandler

func WithUnknownOptionHandler(handler UnknownOptionHandler) ExecOption

WithUnknownOptionHandler enables your customized wrong command/flag processor. internal processor supports smart suggestions for those wrong commands and flags.

func WithWarnForUnknownCommand

func WithWarnForUnknownCommand(b bool) ExecOption

WithWarnForUnknownCommand warns the end user if unknown command found.

By default, cmdr ignore the first unknown command and treat them as remained arguments.

func WithWatchMainConfigFileToo

func WithWatchMainConfigFileToo(b bool) ExecOption

WithWatchMainConfigFileToo enables the watcher on main config file.

By default, cmdr watches all files in the sub-directory `conf.d` of which folder contains the main config file. But as a feature, cmdr ignore the changes in main config file.

WithWatchMainConfigFileToo can switch this feature.

envvars:

CFG_DIR: will be set to the folder contains the main config file
no-watch-conf-dir: if set true, the watcher will be disabled.

func WithXrefBuildingHooks

func WithXrefBuildingHooks(beforeXrefBuildingX, afterXrefBuiltX HookFunc) ExecOption

WithXrefBuildingHooks sets the hook before and after building xref indices. It's replacers for AddOnBeforeXrefBuilding, and AddOnAfterXrefBuilt.

By using beforeXrefBuildingX, you could append, modify, or remove the builtin commands and options.

type ExecWorker

type ExecWorker struct {
	// contains filtered or unexported fields
}

ExecWorker is a core logic worker and holder

func (*ExecWorker) AddOnAfterXrefBuilt

func (w *ExecWorker) AddOnAfterXrefBuilt(cb HookFunc)

AddOnAfterXrefBuilt add hook func daemon plugin needed

func (*ExecWorker) AddOnBeforeXrefBuilding

func (w *ExecWorker) AddOnBeforeXrefBuilding(cb HookFunc)

AddOnBeforeXrefBuilding add hook func daemon plugin needed

func (*ExecWorker) InternalExecFor

func (w *ExecWorker) InternalExecFor(rootCmd *RootCommand, args []string) (last *Command, err error)

InternalExecFor is an internal helper, esp for debugging

type Flag

type Flag struct {
	BaseOpt `yaml:",inline"`

	// ToggleGroup for Toggle Group
	ToggleGroup string `yaml:"toggle-group,omitempty" json:"toggle-group,omitempty"`
	// DefaultValuePlaceholder for flag
	DefaultValuePlaceholder string `yaml:"default-placeholder,omitempty" json:"default-placeholder,omitempty"`
	// DefaultValue default value for flag
	DefaultValue interface{} `yaml:"default,omitempty" json:"default,omitempty"`
	// DefaultValueType is a string to indicate the data-type of DefaultValue.
	// It's only available in loading flag definition from a config-file (yaml/json/...).
	// Never used in writing your codes manually.
	DefaultValueType string `yaml:"type,omitempty" json:"type,omitempty"`
	// ValidArgs for enum flag
	ValidArgs []string `yaml:"valid-args,omitempty" json:"valid-args,omitempty"`
	// Required to-do
	Required bool `yaml:"required,omitempty" json:"required,omitempty"`

	// ExternalTool to get the value text by invoking external tool.
	// It's an environment variable name, such as: "EDITOR" (or cmdr.ExternalToolEditor)
	ExternalTool string `yaml:"external-tool,omitempty" json:"external-tool,omitempty"`

	// EnvVars give a list to bind to environment variables manually
	// it'll take effects since v1.6.9
	EnvVars []string `yaml:"envvars,flow,omitempty" json:"envvars,flow,omitempty"`

	// HeadLike enables a free-hand option like `head -3`.
	//
	// When a free-hand option presents, it'll be treated as a named option with an integer value.
	//
	// For example, option/flag = `{{Full:"line",Short:"l"},HeadLike:true}`, the command line:
	// `app -3`
	// is equivalent to `app -l 3`, and so on.
	//
	// HeadLike assumed an named option with an integer value, that means, Min and Max can be applied on it too.
	// NOTE: Only one head-like option can be defined in a command/sub-command chain.
	HeadLike bool `yaml:"head-like,omitempty" json:"head-like,omitempty"`

	// Min minimal value of a range.
	Min int64 `yaml:"min,omitempty" json:"min,omitempty"`
	// Max maximal value of a range.
	Max int64 `yaml:"max,omitempty" json:"max,omitempty"`
	// contains filtered or unexported fields
}

Flag means a flag, a option, or a opt.

func FindFlag

func FindFlag(longName string, cmd *Command) (res *Flag)

FindFlag find flag with `longName` from `cmd` if cmd == nil: finding from root command

func FindFlagRecursive

func FindFlagRecursive(longName string, cmd *Command) (res *Flag)

FindFlagRecursive find flag with `longName` from `cmd` recursively if cmd == nil: finding from root command

func (*Flag) Delete

func (f *Flag) Delete()

Delete removes myself from the command owner.

func (*Flag) GetDescZsh

func (f *Flag) GetDescZsh() (desc string)

GetDescZsh temp

func (*Flag) GetTitleFlagNames

func (f *Flag) GetTitleFlagNames() string

GetTitleFlagNames temp

func (*Flag) GetTitleFlagNamesBy

func (f *Flag) GetTitleFlagNamesBy(delimChar string) string

GetTitleFlagNamesBy temp

func (*Flag) GetTitleFlagNamesByMax

func (f *Flag) GetTitleFlagNamesByMax(delimChar string, maxShort int) string

GetTitleFlagNamesByMax temp

func (*Flag) GetTitleZshFlagName

func (f *Flag) GetTitleZshFlagName() (str string)

GetTitleZshFlagName temp

func (*Flag) GetTitleZshFlagNamesArray

func (f *Flag) GetTitleZshFlagNamesArray() (ary []string)

GetTitleZshFlagNamesArray temp

func (*Flag) GetTitleZshFlagShortName

func (f *Flag) GetTitleZshFlagShortName() (str string)

GetTitleZshFlagShortName temp

func (*Flag) GetTitleZshNamesBy

func (f *Flag) GetTitleZshNamesBy(delimChar string, allowPrefix, quoted bool) (str string)

GetTitleZshNamesBy temp

func (*Flag) GetTitleZshNamesExtBy

func (f *Flag) GetTitleZshNamesExtBy(delimChar string, allowPrefix, quoted, shortTitleOnly, longTitleOnly bool) (str string)

GetTitleZshNamesExtBy temp

func (*Flag) GetTriggeredTimes

func (f *Flag) GetTriggeredTimes() int

GetTriggeredTimes returns the matched times

type Handler

type Handler func(cmd *Command, args []string) (err error)

Handler handles the event on a subcommand matched

type HookFunc

type HookFunc func(root *RootCommand, args []string)

HookFunc the hook function prototype for SetBeforeXrefBuilding and SetAfterXrefBuilt

type HookHelpScreenFunc

type HookHelpScreenFunc func(w *ExecWorker, p Painter, cmd *Command, justFlags bool)

HookHelpScreenFunc the hook function prototype

type HookOptsFunc

type HookOptsFunc func(root *RootCommand, opts *Options)

HookOptsFunc the hook function prototype

type Invoker

type Invoker func(cmd *Command, args []string)

Invoker is a Handler but without error returns

type Level

type Level uint32

Level type

const (
	// PanicLevel level, highest level of severity. Logs and then calls panic with the
	// message passed to Debug, Info, ...
	PanicLevel Level = iota
	// FatalLevel level. Logs and then calls `logger.Exit(1)`. It will exit even if the
	// logging level is set to Panic.
	FatalLevel
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	// Commonly used for hooks to send errors to an error tracking service.
	ErrorLevel
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
	// TraceLevel level. Designates finer-grained informational events than the Debug.
	TraceLevel
	// OffLevel level. The logger will be shutdown.
	OffLevel
)

These are the different logging levels. You can set the logging level to log on your instance of logger, obtained with `log.NewDummyLogger()`/`log.NewStdLogger()`.

func GetLoggerLevel

func GetLoggerLevel() Level

GetLoggerLevel returns the current logger level after parsed.

func ParseLevel

func ParseLevel(lvl string) (Level, error)

ParseLevel takes a string level and returns the hedzr/log logging level constant.

func (Level) MarshalText

func (level Level) MarshalText() ([]byte, error)

MarshalText convert Level to string and []byte

func (Level) String

func (level Level) String() string

Convert the Level to a string. E.g. PanicLevel becomes "panic".

func (*Level) UnmarshalText

func (level *Level) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type OnOptionSetCB

type OnOptionSetCB func(keyPath string, value, oldVal interface{})

OnOptionSetCB is a callback function while an option is being set (or merged)

type OnPassThruCharHitCB

type OnPassThruCharHitCB func(parsed *Command, switchChar string, args []string) (err error)

OnPassThruCharHitCB is a callback function ...

type OnSet

type OnSet interface {
	// OnSet will be callback'd after this flag parsed
	OnSet(f func(keyPath string, value interface{})) (opt OptFlag)
}

OnSet interface

type OnSwitchCharHitCB

type OnSwitchCharHitCB func(parsed *Command, switchChar string, args []string) (err error)

OnSwitchCharHitCB is a callback function ...

type OptCmd

type OptCmd interface {
	// Titles broken API since v1.6.39
	//
	// If necessary, an order prefix can be attached to the long title.
	// The title with prefix will be set to Name field and striped to Long field.
	//
	// An order prefix is a dotted string with multiple alphabet and digit. Such as:
	// "zzzz.", "0001.", "700.", "A1." ...
	Titles(long, short string, aliases ...string) (opt OptCmd)
	Short(short string) (opt OptCmd)
	Long(long string) (opt OptCmd)
	// Name is an internal identity, and an order prefix is optional
	// An order prefix is a dotted string with multiple alphabet and digit. Such as:
	// "zzzz.", "0001.", "700.", "A1." ...
	Name(name string) (opt OptCmd)
	Aliases(ss ...string) (opt OptCmd)
	Description(oneLine string, long ...string) (opt OptCmd)
	Examples(examples string) (opt OptCmd)
	Group(group string) (opt OptCmd)
	Hidden(hidden bool) (opt OptCmd)
	Deprecated(deprecation string) (opt OptCmd)
	// Action will be triggered after all command-line arguments parsed
	Action(action Handler) (opt OptCmd)

	// PreAction will be invoked before running Action
	// NOTE that RootCommand.PreAction will be invoked too.
	PreAction(pre Handler) (opt OptCmd)
	// PostAction will be invoked after run Action
	// NOTE that RootCommand.PostAction will be invoked too.
	PostAction(post Invoker) (opt OptCmd)

	TailPlaceholder(placeholder string) (opt OptCmd)

	// NewFlag create a new flag object and return it for further operations.
	// Deprecated since v1.6.9, replace it with FlagV(defaultValue)
	//
	// Deprecated since v1.6.50, we recommend the new form:
	//    cmdr.NewBool(false).Titles(...)...AttachTo(ownerCmd)
	NewFlag(typ OptFlagType) (opt OptFlag)
	// NewFlagV create a new flag object and return it for further operations.
	// the titles in arguments MUST be: longTitle, [shortTitle, [aliasTitles...]]
	//
	// Deprecated since v1.6.50, we recommend the new form:
	//    cmdr.NewBool(false).Titles(...)...AttachTo(ownerCmd)
	NewFlagV(defaultValue interface{}, titles ...string) (opt OptFlag)
	// NewSubCommand make a new sub-command optcmd object with optional titles.
	// the titles in arguments MUST be: longTitle, [shortTitle, [aliasTitles...]]
	NewSubCommand(titles ...string) (opt OptCmd)

	OwnerCommand() (opt OptCmd)
	SetOwner(opt OptCmd)

	RootCommand() *RootCommand
	RootCmdOpt() (root *RootCmdOpt)

	ToCommand() *Command

	AddOptFlag(flag OptFlag)
	AddFlag(flag *Flag)
	// AddOptCmd adds 'opt' OptCmd as a sub-command
	AddOptCmd(opt OptCmd)
	// AddCommand adds a *Command as a sub-command
	AddCommand(cmd *Command)
	// AttachTo attaches itself as a sub-command of 'opt' OptCmd object
	AttachTo(opt OptCmd)
	// AttachTo attaches itself as a sub-command of *Command object
	AttachToCommand(cmd *Command)
	// AttachTo attaches itself as a sub-command of *RootCommand object
	AttachToRoot(root *RootCommand)
}

OptCmd to support fluent api of cmdr. see also: cmdr.Root().NewSubCommand()/.NewFlag()

func NewCmd

func NewCmd() (opt OptCmd)

NewCmd creates a wrapped Command object as OptCmd

func NewCmdFrom

func NewCmdFrom(cmd *Command) (opt OptCmd)

NewCmdFrom creates a wrapped Command object as OptCmd, and make it as the current working item.

func NewSubCmd

func NewSubCmd() (opt OptCmd)

NewSubCmd creates a wrapped Command object as OptCmd, and append it into the current working item.

type OptFlag

type OptFlag interface {
	// Titles broken API since v1.6.39.
	//
	// If necessary, an ordered prefix can be attached to the long title.
	// The title with prefix will be set to Name field and striped to Long field.
	//
	// An ordered prefix is a dotted string with multiple alphabets and
	// digits. Such as:
	// "zzzz.", "0001.", "700.", "A1." ...
	Titles(long, short string, aliases ...string) (opt OptFlag)
	Short(short string) (opt OptFlag)
	Long(long string) (opt OptFlag)
	// Name is an internal identity, and an order prefix is optional
	// An ordered prefix is a dotted string with multiple alphabets and
	// digits. Such as:
	// "zzzz.", "0001.", "700.", "A1." ...
	Name(name string) (opt OptFlag)
	Aliases(ss ...string) (opt OptFlag)
	Description(oneLineDesc string, longDesc ...string) (opt OptFlag)
	Examples(examples string) (opt OptFlag)
	Group(group string) (opt OptFlag)
	Hidden(hidden bool) (opt OptFlag)
	Deprecated(deprecation string) (opt OptFlag)
	// Action will be triggered once being parsed ok
	Action(action Handler) (opt OptFlag)

	ToggleGroup(group string) (opt OptFlag)
	// DefaultValue needs an exact typed 'val'.
	// IMPORTANT: cmdr interprets value type of an option based on the underlying default value set.
	DefaultValue(val interface{}, placeholder string) (opt OptFlag)
	Placeholder(placeholder string) (opt OptFlag)
	CompletionActionStr(s string) (opt OptFlag)
	// CompletionMutualExclusiveFlags is a slice of flag full/long titles
	CompletionMutualExclusiveFlags(flags ...string) (opt OptFlag)
	// CompletionPrerequisitesFlags is a slice of flag full/long titles
	CompletionPrerequisitesFlags(flags ...string) (opt OptFlag)
	CompletionJustOnce(once bool) (opt OptFlag)
	CompletionCircuitBreak(once bool) (opt OptFlag)
	DoubleTildeOnly(once bool) (opt OptFlag)
	ExternalTool(envKeyName string) (opt OptFlag)
	ValidArgs(list ...string) (opt OptFlag)
	// HeadLike enables `head -n` mode.
	// 'min', 'max' will be ignored at this version, its might be impl in the future.
	// There's only one head-like flag in one command and its parent and children commands.
	HeadLike(enable bool, min, max int64) (opt OptFlag)

	// EnvKeys is a list of env-var names of binding on this flag
	EnvKeys(keys ...string) (opt OptFlag)
	// Required flag.
	//
	// NOTE
	//
	//   Required() set the required flag to true while it's invoked with empty params.
	Required(required ...bool) (opt OptFlag)

	OwnerCommand() (opt OptCmd)
	SetOwner(opt OptCmd)

	RootCommand() *RootCommand

	ToFlag() *Flag

	// AttachTo attach as a flag of `opt` OptCmd object
	AttachTo(opt OptCmd)
	// AttachToCommand attach as a flag of *Command object
	AttachToCommand(cmd *Command)
	// AttachToRoot attach as a flag of *RootCommand object
	AttachToRoot(root *RootCommand)

	OnSet
}

OptFlag to support fluent api of cmdr. see also: cmdr.Root().NewSubCommand()/.NewFlag()

For an option, its default value must be declared with exact type as is

func NewBool

func NewBool(defaultValue ...bool) (opt OptFlag)

NewBool creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewComplex128

func NewComplex128(defaultValue ...complex128) (opt OptFlag)

NewComplex128 creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewComplex64

func NewComplex64(defaultValue ...complex64) (opt OptFlag)

NewComplex64 creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewDuration

func NewDuration(defaultValue ...time.Duration) (opt OptFlag)

NewDuration creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewDurationFrom

func NewDurationFrom(flg *Flag) (opt OptFlag)

NewDurationFrom creates a wrapped OptFlag, and append it into the current working item.

func NewFloat32

func NewFloat32(defaultValue ...float32) (opt OptFlag)

NewFloat32 creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewFloat64

func NewFloat64(defaultValue ...float64) (opt OptFlag)

NewFloat64 creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewInt

func NewInt(defaultValue ...int) (opt OptFlag)

NewInt creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewInt64

func NewInt64(defaultValue ...int64) (opt OptFlag)

NewInt64 creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewIntSlice

func NewIntSlice(defaultValue ...int) (opt OptFlag)

NewIntSlice creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

Sample:

cmdr.NewIntSlice(1, 2, 3).Titles("int-slice", "is").Group("").
    AttachTo(parentCmdOpt)

func NewString

func NewString(defaultValue ...string) (opt OptFlag)

NewString creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewStringSlice

func NewStringSlice(defaultValue ...string) (opt OptFlag)

NewStringSlice creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

Sample:

cmdr.NewStringSlice("quick", "fox", "jumps").Titles("int-slice", "is").Group("").
    AttachTo(parentCmdOpt)

func NewUint

func NewUint(defaultValue ...uint) (opt OptFlag)

NewUint creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewUint64

func NewUint64(defaultValue ...uint64) (opt OptFlag)

NewUint64 creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

func NewUintSlice

func NewUintSlice(defaultValue ...uint) (opt OptFlag)

NewUintSlice creates a wrapped OptFlag, you can connect it to a OptCmd via OptFlag.AttachXXX later.

Sample:

cmdr.NewUintSlice(1, 2, 3).Titles("uint-slice", "us").Group("").
    AttachTo(parentCmdOpt)

type OptFlagType

type OptFlagType int

OptFlagType to support fluent api of cmdr. see also: OptCmd.NewFlag(OptFlagType)

Usage

root := cmdr.Root()
co := root.NewSubCommand()
co.NewFlag(cmdr.OptFlagTypeUint)

See also those short-hand constructors: Bool(), Int(), ....

const (
	// OptFlagTypeBool to create a new bool flag
	OptFlagTypeBool OptFlagType = iota
	// OptFlagTypeInt to create a new int flag
	OptFlagTypeInt OptFlagType = iota + 1
	// OptFlagTypeUint to create a new uint flag
	OptFlagTypeUint OptFlagType = iota + 2
	// OptFlagTypeInt64 to create a new int64 flag
	OptFlagTypeInt64 OptFlagType = iota + 3
	// OptFlagTypeUint64 to create a new uint64 flag
	OptFlagTypeUint64 OptFlagType = iota + 4
	// OptFlagTypeFloat32 to create a new int float32 flag
	OptFlagTypeFloat32 OptFlagType = iota + 8
	// OptFlagTypeFloat64 to create a new int float64 flag
	OptFlagTypeFloat64 OptFlagType = iota + 9
	// OptFlagTypeComplex64 to create a new int complex64 flag
	OptFlagTypeComplex64 OptFlagType = iota + 10
	// OptFlagTypeComplex128 to create a new int complex128 flag
	OptFlagTypeComplex128 OptFlagType = iota + 11
	// OptFlagTypeString to create a new string flag
	OptFlagTypeString OptFlagType = iota + 12
	// OptFlagTypeStringSlice to create a new string slice flag
	OptFlagTypeStringSlice OptFlagType = iota + 13
	// OptFlagTypeIntSlice to create a new int slice flag
	OptFlagTypeIntSlice OptFlagType = iota + 14
	// OptFlagTypeInt64Slice to create a new int slice flag
	OptFlagTypeInt64Slice OptFlagType = iota + 15
	// OptFlagTypeUint64Slice to create a new int slice flag
	OptFlagTypeUint64Slice OptFlagType = iota + 16
	// OptFlagTypeDuration to create a new duration flag
	OptFlagTypeDuration OptFlagType = iota + 17
	// OptFlagTypeHumanReadableSize to create a new human readable size flag
	OptFlagTypeHumanReadableSize OptFlagType = iota + 18
)

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options is a holder of all options

func GetOptions

func GetOptions() *Options

GetOptions returns the global options instance (rxxtOptions), ie. cmdr Options Store

func (*Options) CheckpointSize

func (s *Options) CheckpointSize() int

CheckpointSize returns how many snapshots made see also SaveCheckpoint

func (*Options) ClearCheckpoints

func (s *Options) ClearCheckpoints()

ClearCheckpoints removes all checkpoints from snapshot history see also SaveCheckpoint

func (*Options) Delete

func (s *Options) Delete(key string)

Delete deletes a key from cmdr options store

func (*Options) DumpAsString

func (s *Options) DumpAsString(showType bool) (str string)

DumpAsString for debugging.

func (*Options) Flush

func (s *Options) Flush()

Flush writes all changes back to the alter config file

func (*Options) FromKibiBytes

func (s *Options) FromKibiBytes(sz string) (ir64 uint64)

FromKibiBytes convert string to the uint64 value based kibibyte format.

kibibyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kibibyte is based 1024. That means: 1 KiB = 1k = 1024 bytes

See also: https://en.wikipedia.org/wiki/Kibibyte Its related word is kilobyte, refer to: https://en.wikipedia.org/wiki/Kilobyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func (*Options) FromKilobytes

func (s *Options) FromKilobytes(sz string) (ir64 uint64)

FromKilobytes convert string to the uint64 value based kilobyte format.

kilobyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kilobyte is based 1000. That means: 1 KB = 1k = 1000 bytes

See also: https://en.wikipedia.org/wiki/Kilobyte Its related word is kibibyte, refer to: https://en.wikipedia.org/wiki/Kibibyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func (*Options) Get

func (s *Options) Get(key string) interface{}

Get an `Option` by key string, eg: ```golang cmdr.Get("app.logger.level") => 'DEBUG',... ```

func (*Options) GetBoolEx

func (s *Options) GetBoolEx(key string, defaultVal ...bool) (ret bool)

GetBoolEx returns the bool value of an `Option` key.

func (*Options) GetComplex128

func (s *Options) GetComplex128(key string, defaultVal ...complex128) (ir complex128)

GetComplex128 returns the complex128 value of an `Option` key.

func (*Options) GetComplex64

func (s *Options) GetComplex64(key string, defaultVal ...complex64) (ir complex64)

GetComplex64 returns the complex64 value of an `Option` key.

func (*Options) GetDuration

func (s *Options) GetDuration(key string, defaultVal ...time.Duration) (ir time.Duration)

GetDuration returns the time duration value of an `Option` key.

func (*Options) GetFloat32Ex

func (s *Options) GetFloat32Ex(key string, defaultVal ...float32) (ir float32)

GetFloat32Ex returns the float32 value of an `Option` key.

func (*Options) GetFloat64Ex

func (s *Options) GetFloat64Ex(key string, defaultVal ...float64) (ir float64)

GetFloat64Ex returns the float64 value of an `Option` key.

func (*Options) GetHierarchyList

func (s *Options) GetHierarchyList() map[string]interface{}

GetHierarchyList returns the hierarchy data for dumping

func (*Options) GetInt64Ex

func (s *Options) GetInt64Ex(key string, defaultVal ...int64) (ir int64)

GetInt64Ex returns the int64 value of an `Option` key.

func (*Options) GetInt64Slice

func (s *Options) GetInt64Slice(key string, defaultVal ...int64) (ir []int64)

GetInt64Slice returns the string slice value of an `Option` key.

func (*Options) GetIntEx

func (s *Options) GetIntEx(key string, defaultVal ...int) (ir int)

GetIntEx returns the int64 value of an `Option` key.

func (*Options) GetIntSlice

func (s *Options) GetIntSlice(key string, defaultVal ...int) (ir []int)

GetIntSlice returns the string slice value of an `Option` key.

func (*Options) GetKibibytesEx

func (s *Options) GetKibibytesEx(key string, defaultVal ...uint64) (ir64 uint64)

GetKibibytesEx returns the uint64 value of an `Option` key based kibibyte format.

kibibyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kibibyte is based 1024. That means: 1 KiB = 1k = 1024 bytes

See also: https://en.wikipedia.org/wiki/Kibibyte Its related word is kilobyte, refer to: https://en.wikipedia.org/wiki/Kilobyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func (*Options) GetKilobytesEx

func (s *Options) GetKilobytesEx(key string, defaultVal ...uint64) (ir64 uint64)

GetKilobytesEx returns the uint64 value of an `Option` key with kilobyte format.

kilobyte format is for human readable. In this format, number presentations are: 2k, 8m, 3g, 5t, 6p, 7e. optional 'b' can be appended, such as: 2kb, 5tb, 7EB. All of them is case-insensitive.

kilobyte is based 1000. That means: 1 KB = 1k = 1000 bytes

See also: https://en.wikipedia.org/wiki/Kilobyte Its related word is kibibyte, refer to: https://en.wikipedia.org/wiki/Kibibyte

The pure number part can be golang presentation, such as 0x99, 0001b, 0700.

func (*Options) GetMap

func (s *Options) GetMap(key string) map[string]interface{}

GetMap an `Option` by key string, it returns a hierarchy map or nil

func (*Options) GetString

func (s *Options) GetString(key string, defaultVal ...string) (ret string)

GetString returns the string value of an `Option` key.

func (*Options) GetStringNoExpand

func (s *Options) GetStringNoExpand(key string, defaultVal ...string) (ret string)

GetStringNoExpand returns the string value of an `Option` key.

func (*Options) GetStringSlice

func (s *Options) GetStringSlice(key string, defaultVal ...string) (ir []string)

GetStringSlice returns the string slice value of an `Option` key.

func (*Options) GetUint64Ex

func (s *Options) GetUint64Ex(key string, defaultVal ...uint64) (ir uint64)

GetUint64Ex returns the uint64 value of an `Option` key.

func (*Options) GetUint64Slice

func (s *Options) GetUint64Slice(key string, defaultVal ...uint64) (ir []uint64)

GetUint64Slice returns the string slice value of an `Option` key.

func (*Options) GetUintEx

func (s *Options) GetUintEx(key string, defaultVal ...uint) (ir uint)

GetUintEx returns the uint64 value of an `Option` key.

func (*Options) Has

func (s *Options) Has(key string) (ok bool)

Has detects whether a key exists in cmdr options store or not

func (*Options) LoadConfigFile

func (s *Options) LoadConfigFile(file string, cft configFileType) (mainFile, subDir string, err error)

LoadConfigFile loads a yaml config file and merge the settings into `rxxtOptions` and load files in the `conf.d` child directory too.

func (*Options) MergeWith

func (s *Options) MergeWith(m map[string]interface{}) (err error)

MergeWith will merge a map recursive.

func (*Options) Reset

func (s *Options) Reset()

Reset the exists `Options`, so that you could follow a `LoadConfigFile()` with it.

func (*Options) RestoreCheckpoint

func (s *Options) RestoreCheckpoint(n ...int) (err error)

RestoreCheckpoint restore 1 or n checkpoint(s) from snapshots history. see also SaveCheckpoint

func (*Options) SaveCheckpoint

func (s *Options) SaveCheckpoint() (err error)

SaveCheckpoint make a snapshot of the current Option Store

You may ResetOptions after SaveCheckpoint:

func x(aMap map[string]interface{}){
    defer cmdr.RestoreCheckpoint()
    cmdr.SaveCheckpoint()
    cmdr.ResetOptions()
    cmdr.MergeWith(map[string]interface{}{
      "app": map[string]interface{}{
        conf.AppName: map[string]interface{}{
          "a-map": aMap,
        }
      }
    }
    cmdr.SaveAsYaml("a-setting.yml")
}

func (*Options) Set

func (s *Options) Set(key string, val interface{})

Set set the value of an `Option` key. The key MUST not have an `app` prefix. eg: ```golang cmdr.Set("debug", true) cmdr.GetBool("app.debug") => true ```

func (*Options) SetNx

func (s *Options) SetNx(key string, val interface{})

SetNx but without prefix auto-wrapped. `rxxtPrefix` is a string slice to define the prefix string array, default is ["app"]. So, cmdr.SetNx("debug", true) will put a real entry with (`debug`, true).

func (*Options) SetRaw

func (s *Options) SetRaw(key string, val interface{})

SetRaw but without prefix auto-wrapped. So, cmdr.SetRaw("debug", true) will put a real entry with (`debug`, true).

type Painter

type Painter interface {
	Printf(fmtStr string, args ...interface{})
	Print(fmtStr string, args ...interface{})

	FpPrintHeader(command *Command)
	FpPrintHelpTailLine(command *Command)

	FpUsagesTitle(command *Command, title string)
	FpUsagesLine(command *Command, fmt, appName, cmdList, cmdsTitle, tailPlaceHolder string)
	FpDescTitle(command *Command, title string)
	FpDescLine(command *Command)
	FpExamplesTitle(command *Command, title string)
	FpExamplesLine(command *Command)

	FpCommandsTitle(command *Command)
	FpCommandsGroupTitle(group string)
	FpCommandsLine(command *Command) (bufL, bufR bytes.Buffer)
	FpFlagsTitle(command *Command, flag *Flag, title string)
	FpFlagsGroupTitle(group string, isToggleGroup bool)
	FpFlagsLine(command *Command, flag *Flag, maxShort int, defValStr string) (bufL, bufR bytes.Buffer)

	Flush()

	Results() []byte

	// clear any internal states and reset itself
	Reset()
}

Painter to support the genManual, genMarkdown, printHelpScreen.

type RootCmdOpt

type RootCmdOpt struct {
	// contains filtered or unexported fields
}

RootCmdOpt for fluent api

func Root

func Root(appName, version string) (opt *RootCmdOpt)

Root for fluent api, to create a new *RootCmdOpt object.

func RootFrom

func RootFrom(root *RootCommand) (opt *RootCmdOpt)

RootFrom for fluent api, to create the new *RootCmdOpt object from an existed RootCommand

func (*RootCmdOpt) Action

func (s *RootCmdOpt) Action(action Handler) (opt OptCmd)

func (*RootCmdOpt) AddCommand

func (s *RootCmdOpt) AddCommand(cmd *Command)

func (*RootCmdOpt) AddFlag

func (s *RootCmdOpt) AddFlag(flag *Flag)

func (*RootCmdOpt) AddGlobalPostAction

func (s *RootCmdOpt) AddGlobalPostAction(post Invoker) *RootCmdOpt

AddGlobalPostAction attaches your post handler to the global Post-Actions list

func (*RootCmdOpt) AddGlobalPreAction

func (s *RootCmdOpt) AddGlobalPreAction(pre Handler) *RootCmdOpt

AddGlobalPreAction attaches your pre handler to the global Pre-Actions list

func (*RootCmdOpt) AddOptCmd

func (s *RootCmdOpt) AddOptCmd(opt OptCmd)

func (*RootCmdOpt) AddOptFlag

func (s *RootCmdOpt) AddOptFlag(flag OptFlag)

func (*RootCmdOpt) Aliases

func (s *RootCmdOpt) Aliases(aliases ...string) (opt OptCmd)

func (*RootCmdOpt) AppendPostActions

func (s *RootCmdOpt) AppendPostActions(fns ...func(cmd *Command, args []string))

AppendPostActions adds the global post-action to cmdr system

func (*RootCmdOpt) AppendPreActions

func (s *RootCmdOpt) AppendPreActions(fns ...func(cmd *Command, args []string) (err error))

AppendPreActions adds the global pre-action to cmdr system

func (*RootCmdOpt) AttachTo

func (s *RootCmdOpt) AttachTo(opt OptCmd)

func (*RootCmdOpt) AttachToCommand

func (s *RootCmdOpt) AttachToCommand(cmd *Command)

func (*RootCmdOpt) AttachToRoot

func (s *RootCmdOpt) AttachToRoot(root *RootCommand)

func (*RootCmdOpt) Bool

func (s *RootCmdOpt) Bool() (opt OptFlag)

func (*RootCmdOpt) Complex128

func (s *RootCmdOpt) Complex128() (opt OptFlag)

func (*RootCmdOpt) Complex64

func (s *RootCmdOpt) Complex64() (opt OptFlag)

func (*RootCmdOpt) Copyright

func (s *RootCmdOpt) Copyright(copyright, author string) *RootCmdOpt

Copyright for fluent api

func (*RootCmdOpt) Deprecated

func (s *RootCmdOpt) Deprecated(deprecation string) (opt OptCmd)

func (*RootCmdOpt) Description

func (s *RootCmdOpt) Description(oneLine string, long ...string) (opt OptCmd)

func (*RootCmdOpt) Duration

func (s *RootCmdOpt) Duration() (opt OptFlag)

func (*RootCmdOpt) Examples

func (s *RootCmdOpt) Examples(examples string) (opt OptCmd)

func (*RootCmdOpt) Float32

func (s *RootCmdOpt) Float32() (opt OptFlag)

func (*RootCmdOpt) Float64

func (s *RootCmdOpt) Float64() (opt OptFlag)

func (*RootCmdOpt) Group

func (s *RootCmdOpt) Group(group string) (opt OptCmd)

func (*RootCmdOpt) Header

func (s *RootCmdOpt) Header(header string) *RootCmdOpt

Header for fluent api

func (*RootCmdOpt) Hidden

func (s *RootCmdOpt) Hidden(hidden bool) (opt OptCmd)

func (*RootCmdOpt) Int

func (s *RootCmdOpt) Int() (opt OptFlag)

func (*RootCmdOpt) Int64

func (s *RootCmdOpt) Int64() (opt OptFlag)

func (*RootCmdOpt) IntSlice

func (s *RootCmdOpt) IntSlice() (opt OptFlag)

func (*RootCmdOpt) Long

func (s *RootCmdOpt) Long(long string) (opt OptCmd)

func (*RootCmdOpt) Name

func (s *RootCmdOpt) Name(name string) (opt OptCmd)

func (*RootCmdOpt) NewFlag

func (s *RootCmdOpt) NewFlag(typ OptFlagType) (opt OptFlag)

func (*RootCmdOpt) NewFlagV

func (s *RootCmdOpt) NewFlagV(defaultValue interface{}, titles ...string) (opt OptFlag)

func (*RootCmdOpt) NewSubCommand

func (s *RootCmdOpt) NewSubCommand(titles ...string) (opt OptCmd)

func (*RootCmdOpt) OwnerCommand

func (s *RootCmdOpt) OwnerCommand() (opt OptCmd)

func (*RootCmdOpt) PostAction

func (s *RootCmdOpt) PostAction(post Invoker) (opt OptCmd)

func (*RootCmdOpt) PreAction

func (s *RootCmdOpt) PreAction(pre Handler) (opt OptCmd)

func (*RootCmdOpt) RootCmdOpt

func (s *RootCmdOpt) RootCmdOpt() (root *RootCmdOpt)

func (*RootCmdOpt) RootCommand

func (s *RootCmdOpt) RootCommand() (root *RootCommand)

func (*RootCmdOpt) SetOwner

func (s *RootCmdOpt) SetOwner(opt OptCmd)

func (*RootCmdOpt) Short

func (s *RootCmdOpt) Short(short string) (opt OptCmd)

func (*RootCmdOpt) String

func (s *RootCmdOpt) String() (opt OptFlag)

func (*RootCmdOpt) StringSlice

func (s *RootCmdOpt) StringSlice() (opt OptFlag)

func (*RootCmdOpt) TailPlaceholder

func (s *RootCmdOpt) TailPlaceholder(placeholder string) (opt OptCmd)

func (*RootCmdOpt) Titles

func (s *RootCmdOpt) Titles(long, short string, aliases ...string) (opt OptCmd)

func (*RootCmdOpt) ToCommand

func (s *RootCmdOpt) ToCommand() *Command

func (*RootCmdOpt) Uint

func (s *RootCmdOpt) Uint() (opt OptFlag)

func (*RootCmdOpt) Uint64

func (s *RootCmdOpt) Uint64() (opt OptFlag)

type RootCommand

type RootCommand struct {
	Command `yaml:",inline"`

	AppName    string `yaml:"appname,omitempty" json:"appname,omitempty"`
	Version    string `yaml:"version,omitempty" json:"version,omitempty"`
	VersionInt uint32 `yaml:"version-int,omitempty" json:"version-int,omitempty"`

	Copyright string `yaml:"copyright,omitempty" json:"copyright,omitempty"`
	Author    string `yaml:"author,omitempty" json:"author,omitempty"`
	Header    string `yaml:"header,omitempty" json:"header,omitempty"` // using `Header` for header and ignore built with `Copyright` and `Author`, and no usage lines too.

	PreActions  []Handler `yaml:"-" json:"-"`
	PostActions []Invoker `yaml:"-" json:"-"`
	// contains filtered or unexported fields
}

RootCommand holds some application information

func (*RootCommand) AppendPostActions

func (c *RootCommand) AppendPostActions(fns ...func(cmd *Command, args []string))

AppendPostActions adds the global post-action to cmdr system

func (*RootCommand) AppendPreActions

func (c *RootCommand) AppendPreActions(fns ...func(cmd *Command, args []string) (err error))

AppendPreActions adds the global pre-action to cmdr system

type UnhandledErrorHandler

type UnhandledErrorHandler func(err interface{})

UnhandledErrorHandler for WithUnhandledErrorHandler

type UnknownOptionHandler

type UnknownOptionHandler func(isFlag bool, title string, cmd *Command, args []string) (fallbackToDefaultDetector bool)

UnknownOptionHandler for WithSimilarThreshold/SetUnknownOptionHandler