cmdr

Oct 15, 2023

Changes in this version

type Flag

+ func (f *Flag) GetDottedNamePathEx() string

Sep 29, 2023

Changes in this version

+ var ErrNotImpl = errorsStd.New("not implements")

Mar 4, 2023

Changes in this version

+ func Parsed() bool

+ func RemoveAllOnConfigLoadedListeners()

+ func SetNoColorMode(b bool)

+ func SetQuietMode(b bool)

+ func SetVerboseMode(b bool)

type ExecOption

+ func WithNoWarnings(b bool) ExecOption

Feb 21, 2023

Changes in this version

type ExecOption

+ func WithIIfOpt(condition bool, yes, no func() ExecOption) ExecOption

+ func WithIfOpt(condition bool, yes func() ExecOption) ExecOption

Jan 30, 2023

Changes in this version

+ func PartialContains(names []string, partialNeedle string) (index int, matched string, contains bool)

Aug 8, 2022

Changes in this version

type OptFlag

+ func NewAny(defaultValue ...any) (opt OptFlag)

+ func NewTextVar(defaultValue ...TextVar) (opt OptFlag)

type Options

+ func (s *Options) GetTextVar(key string, defaultVal ...TextVar) (ir TextVar)

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

+ type TextVar interface

+ func GetTextVar(key string, defaultVal ...TextVar) TextVar

+ func GetTextVarP(prefix, key string, defaultVal ...TextVar) TextVar

+ func GetTextVarR(key string, defaultVal ...TextVar) TextVar

+ func GetTextVarRP(prefix, key string, defaultVal ...TextVar) TextVar

Apr 21, 2022

Changes in this version

type Command

+ TailPlaceHolders []string

Feb 20, 2022

Changes in this version

+ func AttachLiveArgsTo(err error, liveArgs ...interface{}) error

+ func IsIgnorableError(err error) bool

+ func NewErrorForCmdr(msg string, args ...interface{}) error

+ func SetAsAnIgnorableError(err error, ignorable bool) error

type BaseOpt

+ func (s *BaseOpt) GetHitStr() string

type Command

+ func GetHitCommands() []*Command

+ func (c *Command) EqualTo(rh *Command) (ok bool)

type ErrorForCmdr

+ func UnwrapError(err error) (e *ErrorForCmdr, ignorable, ok bool)

+ func UnwrapLiveArgsFromCmdrError(err error) (liveArgs []interface{}, e *ErrorForCmdr, ok bool)

type ExecOption

+ func WithInternalDefaultAction(useInternalDefaultAction bool, userDefinedActionHandler ...Handler) ExecOption

+ func WithShellCompletionCommandEnabled(b bool) ExecOption

type Flag

+ func GetHitFlags() []*Flag

+ func (f *Flag) EqualTo(rh *Flag) (ok bool)

type OptCmd

+ Sets func(func(cmd OptCmd)) (opt OptCmd)

type RootCmdOpt

+ func (s *RootCmdOpt) Sets(cb func(cmd OptCmd)) (opt OptCmd)

Feb 11, 2022

Changes in this version

+ const BgInverse

+ const BgStrikeout

+ func SaveAsJSONExt(filename string, prettyFormat bool) (err error)

+ func SetNxOverwrite(key string, val interface{})

+ func SetOverwrite(key string, val interface{})

+ func StripHTMLTags(s string) string

+ func StripLeftTabs(s string) string

+ func StripLeftTabsOnly(s string) string

type BaseOpt

+ VendorHidden bool

+ type ColorTranslator interface

+ Translate func(s string, initialFg int) string

type Command

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

+ func (c *Command) Match(title string) (ok bool)

type OptCmd

+ VendorHidden func(hidden bool) (opt OptCmd)

type OptFlag

+ VendorHidden func(hidden bool) (opt OptFlag)

type Options

+ func CurrentOptions() *Options

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

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

type RootCmdOpt

+ func (s *RootCmdOpt) RunAsSubCommand(dottedPathToSubCommand string) *RootCmdOpt

+ func (s *RootCmdOpt) VendorHidden(hidden bool) (opt OptCmd)

type RootCommand

+ RunAsSubCommand string

Feb 2, 2022

Changes in this version

+ func GetAlterConfigWriteBackMode() bool

+ func SetAlterConfigWriteBackMode(enabled bool)

type ExecOption

+ func WithAlterConfigAutoWriteBack(writeChanges bool) ExecOption

type Flag

+ func (f *Flag) GetDottedNamePath() string

type Options

+ func (s *Options) Wrap(key string) string

Jan 31, 2022

Changes in this version

+ func GetSecondaryLocations() []string

+ func GetUsedSecondaryConfigFile() string

+ func GetUsedSecondaryConfigSubDir() string

type ExecOption

+ func WithSecondaryLocations(locations ...string) ExecOption

Jan 31, 2022

Changes in this version

+ func GetPredefinedAlterLocations() []string

+ func GetUsedAlterConfigFile() string

+ func GetUsedAlterConfigSubDir() string

Jan 29, 2022

Changes in this version

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

Jan 26, 2022

Changes in this version

+ var CurrentDeprecatedColor = FgDarkGray

+ var CurrentHiddenColor = FgDarkGray

+ func CheckpointSize() int

+ func ClearCheckpoints()

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

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

+ func GetDebugModeHitCount() int

+ func GetFlagHitCount(longName string) int

+ func GetFlagHitCountRecursively(longName string) int

+ func GetHitCountByDottedPath(dottedPath string) int

+ func GetNoColorModeHitCount() int

+ func GetQuietModeHitCount() int

+ func GetTraceModeHitCount() int

+ func GetVerboseModeHitCount() int

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

+ func SaveCheckpoint() (err error)

type Command

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

+ func (c *Command) Delete()

+ func (c *Command) GetTriggeredTimes() int

type ExecOption

+ func WithCommandSystemCustomizing(customizer HookFunc) ExecOption

type Flag

+ func (c *Flag) Delete()

type Options

+ func (s *Options) CheckpointSize() int

+ func (s *Options) ClearCheckpoints()

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

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

Jan 11, 2022

Changes in this version

+ func DebugOutputTildeInfo(showType bool)

Dec 3, 2021

Changes in this version

+ func SetRaw(key string, val interface{})

type BaseOpt

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

+ func (s *BaseOpt) GetTitleZshNames() string

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

type Flag

+ func (s *Flag) GetTitleZshFlagShortName() (str string)

+ func (s *Flag) GetTitleZshNamesBy(delimChar string, allowPrefix bool) (str string)

+ func (s *Flag) GetTitleZshNamesExtBy(delimChar string, allowPrefix, shortTitleOnly, longTitleOnly bool) (str string)

type OptFlag

+ CompletionActionStr func(s string) (opt OptFlag)

+ CompletionCircuitBreak func(once bool) (opt OptFlag)

+ CompletionJustOnce func(once bool) (opt OptFlag)

+ CompletionMutualExclusiveFlags func(flags ...string) (opt OptFlag)

+ CompletionPrerequisitesFlags func(flags ...string) (opt OptFlag)

+ DoubleTildeOnly func(once bool) (opt OptFlag)

type Options

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

Nov 24, 2021

Changes in this version

type ExecOption

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

+ func WithToggleGroupChoicerStyle(style string) ExecOption

Apr 14, 2021

Changes in this version

type ExecOption

+ func WithGlobalPostActions(fns ...Invoker) ExecOption

+ func WithGlobalPreActions(fns ...Handler) ExecOption

type OptCmd

+ RootCmdOpt func() (root *RootCmdOpt)

type RootCmdOpt

+ 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) RootCmdOpt() (root *RootCmdOpt)

type RootCommand

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

Mar 3, 2021

Changes in this version

type ExecOption

+ func WithConfigFileLoadingHooks(before, after HookFunc) ExecOption

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

Dec 6, 2020

Changes in this version

type ExecOption

+ func WithAlterLocations(locations ...string) ExecOption

type Options

+ func (s *Options) Flush()

Oct 21, 2020

Changes in this version

type ExecOption

+ func WithWarnForUnknownCommand(b bool) ExecOption

Oct 17, 2020

Changes in this version

+ func GetWatchingConfigFiles() []string

type ExecOption

+ func WithConfigSubDirAutoName(folderName string) ExecOption

+ func WithSearchAlterConfigFiles(b bool) ExecOption

Oct 8, 2020

Changes in this version

+ func InDockerEnv() (status bool)

Oct 8, 2020

Changes in this version

+ func InDevelopingTime() (status bool)

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

+ func SetDebugMode(b bool)

+ func SetTraceMode(b bool)

Oct 5, 2020

Changes in this version

+ func EnableShellPager(enabled bool)

+ func GetRemainArgs() []string

type ExecOption

+ func WithHelpScreenHooks(before, after HookHelpScreenFunc) ExecOption

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

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

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

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

type Options

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

Sep 28, 2020

Changes in this version

+ const AliasesGroup

type Command

+ Invoke string

+ InvokeProc string

+ InvokeShell string

+ Shell string

type Flag

+ DefaultValueType string

Sep 27, 2020

Changes in this version

type ExecOption

+ func WithExtensionsLocations(locations ...string) ExecOption

+ func WithPluginLocations(locations ...string) ExecOption

Sep 20, 2020

Changes in this version

+ const AddonsGroup

+ const ExtGroup

Aug 17, 2020

Changes in this version

+ func SetLogger(l log.Logger)

Aug 15, 2020

Changes in this version

type Painter

+ Print func(fmtStr string, args ...interface{})

Aug 14, 2020

Changes in this version

+ func GetExecutablePath() string

Aug 12, 2020

Changes in this version

+ var Logger log.Logger = log.NewDummyLogger()

type ExecOption

+ func WithLogx(logger log.Logger) ExecOption

Jul 29, 2020

Changes in this version

+ func NewLoggerConfig() *log.LoggerConfig

Jul 27, 2020

Changes in this version

+ func EnsureDirEnh(dir string) (err error)

+ func GetTraceMode() bool

type RootCmdOpt

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

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

type RootCommand

+ PreActions []Handler

Jul 24, 2020

Changes in this version

type OptFlag

+ Required func(required ...bool) (opt OptFlag)

Jul 20, 2020

Changes in this version

+ func HasOrderPrefix(s string) bool

Jul 13, 2020

Changes in this version

type OptCmd

+ Name func(name string) (opt OptCmd)

type OptFlag

+ Name func(name string) (opt OptFlag)

type RootCmdOpt

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

Jun 7, 2020

Changes in this version

type OptFlag

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

Jun 6, 2020

Changes in this version

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

May 26, 2020

Changes in this version

type ExecOption

+ func WithPagerEnabled() ExecOption

May 23, 2020

Changes in this version

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

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

Apr 11, 2020

Changes in this version

+ func IsZero(v reflect.Value) bool

Mar 21, 2020

Changes in this version

type ExecOption

+ func WithLogexSkipFrames(skipFrames int) ExecOption

Feb 29, 2020

Changes in this version

type Copier

+ SetEachFieldAlways func(b bool) Copier

+ SetIgnoreNames func(ignoreNames ...string) Copier

Feb 7, 2020

Changes in this version

+ var AllLevels = []Level

+ type Level uint32

+ const DebugLevel

+ const ErrorLevel

+ const FatalLevel

+ const InfoLevel

+ const OffLevel

+ const PanicLevel

+ const TraceLevel

+ const WarnLevel

+ func GetLoggerLevel() Level

+ func ParseLevel(lvl string) (Level, error)

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

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

+ func (level Level) String() string

Jan 15, 2020

Changes in this version

type RootCommand

+ PostActions []func(cmd *Command, args []string)

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

Jan 14, 2020

Changes in this version

+ 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 ParseComplex(s string) (v complex128)

+ func ParseComplexX(s string) (v complex128, err error)

type ErrorForCmdr

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

+ func (w *ErrorForCmdr) Cause() error

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

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

+ func (w *ErrorForCmdr) Unwrap() error

type OptFlag

+ func NewComplex128(defaultValue complex128) (opt OptFlag)

+ func NewComplex64(defaultValue complex64) (opt OptFlag)

type OptFlagType

+ const OptFlagTypeComplex128

+ const OptFlagTypeComplex64

type Options

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

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

type RootCmdOpt

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

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

Jan 9, 2020

Changes in this version

+ 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

type Command

+ func (c *Command) GetDottedNamePath() string

type OptFlagType

+ const OptFlagTypeHumanReadableSize

+ const OptFlagTypeInt64Slice

+ const OptFlagTypeUint64Slice

type Options

+ func (s *Options) FromKibibytes(sz string) (ir64 uint64)

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

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

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

Jan 4, 2020

Changes in this version

type 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

Dec 30, 2019

Changes in this version

type Command

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

type ExecOption

+ func WithNoCommandAction(b bool) ExecOption

Dec 26, 2019

Changes in this version

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

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

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

type ExecOption

+ func WithUnhandledErrorHandler(handler UnhandledErrorHandler) ExecOption

+ type UnhandledErrorHandler func(err interface{})

Dec 24, 2019

Changes in this version

type ExecOption

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

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

Dec 22, 2019

Changes in this version

type ExecOption

+ func WithHelpTailLine(line string) ExecOption

Dec 10, 2019

Changes in this version

+ func GetUsingConfigFiles() []string

type ErrorForCmdr

+ func (e *ErrorForCmdr) Attach(errors ...error) *ErrorForCmdr

+ func (e *ErrorForCmdr) Format(args ...interface{}) *ErrorForCmdr

+ func (e *ErrorForCmdr) Nest(errors ...error) *ErrorForCmdr

+ func (e *ErrorForCmdr) Template(tmpl string) *ErrorForCmdr

type ExecOption

+ func WithNoWatchConfigFiles(b bool) ExecOption

+ func WithWatchMainConfigFileToo(b bool) ExecOption

Dec 5, 2019

Changes in this version

+ func PressAnyKeyToContinue(msg ...string) (input string)

+ func PressEnterToContinue(msg ...string) (input string)

+ func StripPrefix(s, p string) string

+ func StripQuotes(s string) string

+ type OnSet interface

+ OnSet func(f func(keyPath string, value interface{})) (opt OptFlag)

type OptCmd

+ NewFlagV func(defaultValue interface{}) (opt OptFlag)

type OptFlag

+ EnvKeys func(keys ...string) (opt OptFlag)

+ Placeholder func(placeholder string) (opt OptFlag)

type RootCmdOpt

+ func (s *RootCmdOpt) NewFlagV(defaultValue interface{}) (opt OptFlag)

Nov 16, 2019

Changes in this version

+ var ErrBadArg = errors.New("bas argument")

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

+ func IsDebuggerAttached() bool

+ func SignalQuitSignal() — darwin/amd64, linux/amd64, windows/amd64

+ func SignalTermSignal() — darwin/amd64, linux/amd64, windows/amd64

+ func SignalToSelf(sig os.Signal) (err error) — darwin/amd64, linux/amd64, windows/amd64

+ func TrapSignalsEnh(done chan bool, onTrapped func(s os.Signal), signals ...os.Signal) (waiter func()) — darwin/amd64, linux/amd64, windows/amd64

type OptCmd

+ AddCommand func(cmd *Command)

+ AddFlag func(flag *Flag)

+ AddOptCmd func(opt OptCmd)

+ AddOptFlag func(flag OptFlag)

+ AttachTo func(opt OptCmd)

+ AttachToCommand func(cmd *Command)

+ AttachToRoot func(root *RootCommand)

+ ToCommand func() *Command

type OptFlag

+ AttachTo func(opt OptCmd)

+ AttachToCommand func(cmd *Command)

+ AttachToRoot func(root *RootCommand)

+ ToFlag func() *Flag

type Options

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

type RootCmdOpt

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

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

+ func (s *RootCmdOpt) AddOptCmd(opt OptCmd)

+ func (s *RootCmdOpt) AddOptFlag(flag OptFlag)

+ func (s *RootCmdOpt) AttachTo(opt OptCmd)

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

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

+ func (s *RootCmdOpt) ToCommand() *Command

Nov 6, 2019

Changes in this version

type ExecOption

+ func WithLogexPrefix(prefix string) ExecOption

Nov 1, 2019

Changes in this version

+ func DeleteKey(key string)

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

+ 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 HasKey(key string) (ok bool)

+ func RemoveDirRecursive(dir string) (err error)

type ExecOption

+ func WithAfterArgsParsed(hookFunc func(cmd *Command, args []string) (err error)) ExecOption

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

+ func WithLogex() ExecOption

+ func WithNoColor(b bool) ExecOption

+ func WithNoEnvOverrides(b bool) ExecOption

+ func WithStrictMode(b bool) ExecOption

type Flag

+ EnvVars []string

type Options

+ func (s *Options) Delete(key string)

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

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

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

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

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

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

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

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

Oct 10, 2019

Changes in this version

+ func GetExecutableDir() string

type ExecOption

+ func WithNoDefaultHelpScreen(b bool) ExecOption

type ExecWorker

+ func InternalGetWorker() (w *ExecWorker)

+ func InternalResetWorker() (w *ExecWorker)

Oct 8, 2019

Changes in this version

type ExecOption

+ func WithSimilarThreshold(similiarThreshold float64) ExecOption

+ func WithUnknownOptionHandler(handler UnknownOptionHandler) ExecOption

type Options

+ func (s *Options) GetInt64Slice(key string) (ir []int64)

+ func (s *Options) GetUint64Slice(key string) (ir []uint64)

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

Oct 5, 2019

Changes in this version

type Command

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

type ExecOption

+ func WithAutomaticEnvHooks(hook HookOptsFunc) ExecOption

type Flag

+ func (s *Flag) GetTriggeredTimes() int

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

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

Sep 26, 2019

Changes in this version

type Command

+ func (c *Command) PrintBuildInfo()

+ type ExecOption func(w *ExecWorker)

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

+ func WithConfigLoadedListener(c ConfigReloaded) ExecOption

+ func WithCustomShowBuildInfo(fn func()) ExecOption

+ func WithCustomShowVersion(fn func()) ExecOption

+ func WithEnvPrefix(prefix []string) ExecOption

+ func WithHelpPainter(painter Painter) ExecOption

+ func WithHelpTabStop(tabStop int) ExecOption

+ func WithIgnoreWrongEnumValue(ignored bool) ExecOption

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

+ func WithNoLoadConfigFiles(b bool) ExecOption

+ func WithOptionsPrefix(prefix []string) ExecOption

+ func WithPredefinedLocations(locations []string) ExecOption

+ func WithRxxtPrefix(prefix []string) ExecOption

+ func WithXrefBuildingHooks(beforeXrefBuildingX, afterXrefBuiltX HookXrefFunc) ExecOption

+ type ExecWorker struct

+ func (w *ExecWorker) AddOnAfterXrefBuilt(cb HookXrefFunc)

+ func (w *ExecWorker) AddOnBeforeXrefBuilding(cb HookXrefFunc)

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

type Options

+ func GetOptions() *Options

Aug 31, 2019

Changes in this version

+ func TrapSignals(onTrapped func(s os.Signal)) (waiter func()) — darwin/amd64, linux/amd64, windows/amd64

Aug 20, 2019

Changes in this version

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

type Options

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

Aug 12, 2019

Changes in this version

+ type DistanceOption func(StringDistance)

+ func JWWithThreshold(threshold float64) DistanceOption

+ type StringDistance interface

+ Calc func(s1, s2 string, opts ...DistanceOption) (distance int)

+ func JaroWinklerDistance(opts ...DistanceOption) StringDistance

Jul 31, 2019

Changes in this version

+ func AsJSON() (b []byte)

+ func AsToml() (b []byte)

+ func AsYaml() (b []byte)

+ func GetHierarchyList() map[string]interface

Jul 21, 2019

Changes in this version

type BoolOpt

+ func (s *BoolOpt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type DurationOpt

+ func (s *DurationOpt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type Float32Opt

+ func (s *Float32Opt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type Float64Opt

+ func (s *Float64Opt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type Int64Opt

+ func (s *Int64Opt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type IntOpt

+ func (s *IntOpt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type IntSliceOpt

+ func (s *IntSliceOpt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type OptFlag

+ func NewDurationFrom(flg *Flag) (opt OptFlag)

+ OnSet func(func(keyPath string, value interface{})) (opt OptFlag)

type RootCmdOpt

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

type StringOpt

+ func (s *StringOpt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type StringSliceOpt

+ func (s *StringSliceOpt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type Uint64Opt

+ func (s *Uint64Opt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

type UintOpt

+ func (s *UintOpt) OnSet(f func(keyPath string, value interface{})) (opt OptFlag)

Jul 20, 2019

Changes in this version

+ var ShouldIgnoreWrongEnumValue = false

+ func IsDigitHeavy(s string) bool

type BoolOpt

+ func (s *BoolOpt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *BoolOpt) ValidArgs(list ...string) (opt OptFlag)

type DurationOpt

+ func (s *DurationOpt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *DurationOpt) ValidArgs(list ...string) (opt OptFlag)

+ type ErrorForCmdr struct

+ Ignorable bool

+ Inner error

+ Msg string

+ func NewError(ignorable bool, inner error, args ...interface{}) *ErrorForCmdr

+ func NewErrorWithMsg(msg string, inner error) *ErrorForCmdr

+ func (s *ErrorForCmdr) Error() string

type Flag

+ HeadLike bool

+ Max int64

+ Min int64

type Float32Opt

+ func (s *Float32Opt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *Float32Opt) ValidArgs(list ...string) (opt OptFlag)

type Float64Opt

+ func (s *Float64Opt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *Float64Opt) ValidArgs(list ...string) (opt OptFlag)

type Int64Opt

+ func (s *Int64Opt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *Int64Opt) ValidArgs(list ...string) (opt OptFlag)

type IntOpt

+ func (s *IntOpt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *IntOpt) ValidArgs(list ...string) (opt OptFlag)

type IntSliceOpt

+ func (s *IntSliceOpt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *IntSliceOpt) ValidArgs(list ...string) (opt OptFlag)

type OptFlag

+ HeadLike func(enable bool, min, max int64) (opt OptFlag)

+ ValidArgs func(list ...string) (opt OptFlag)

type StringOpt

+ func (s *StringOpt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *StringOpt) ValidArgs(list ...string) (opt OptFlag)

type StringSliceOpt

+ func (s *StringSliceOpt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *StringSliceOpt) ValidArgs(list ...string) (opt OptFlag)

type Uint64Opt

+ func (s *Uint64Opt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *Uint64Opt) ValidArgs(list ...string) (opt OptFlag)

type UintOpt

+ func (s *UintOpt) HeadLike(enable bool, min, max int64) (opt OptFlag)

+ func (s *UintOpt) ValidArgs(list ...string) (opt OptFlag)

Jul 18, 2019

Changes in this version

+ func GetFloat32(key string) float32

+ func GetFloat32P(prefix, key string) float32

+ func GetFloat32R(key string) float32

+ func GetFloat32RP(prefix, key string) float32

+ func GetFloat64(key string) float64

+ func GetFloat64P(prefix, key string) float64

+ func GetFloat64R(key string) float64

+ func GetFloat64RP(prefix, key string) float64

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

type CmdOpt

+ func (s *CmdOpt) Float32() (opt OptFlag)

+ func (s *CmdOpt) Float64() (opt OptFlag)

+ type Float32Opt struct

+ func (s *Float32Opt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *Float32Opt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *Float32Opt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *Float32Opt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *Float32Opt) Description(oneLine, long string) (opt OptFlag)

+ func (s *Float32Opt) Examples(examples string) (opt OptFlag)

+ func (s *Float32Opt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *Float32Opt) Group(group string) (opt OptFlag)

+ func (s *Float32Opt) Hidden(hidden bool) (opt OptFlag)

+ func (s *Float32Opt) Long(long string) (opt OptFlag)

+ func (s *Float32Opt) OwnerCommand() (opt OptCmd)

+ func (s *Float32Opt) RootCommand() (root *RootCommand)

+ func (s *Float32Opt) SetOwner(opt OptCmd)

+ func (s *Float32Opt) Short(short string) (opt OptFlag)

+ func (s *Float32Opt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *Float32Opt) ToggleGroup(group string) (opt OptFlag)

+ type Float64Opt struct

+ func (s *Float64Opt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *Float64Opt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *Float64Opt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *Float64Opt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *Float64Opt) Description(oneLine, long string) (opt OptFlag)

+ func (s *Float64Opt) Examples(examples string) (opt OptFlag)

+ func (s *Float64Opt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *Float64Opt) Group(group string) (opt OptFlag)

+ func (s *Float64Opt) Hidden(hidden bool) (opt OptFlag)

+ func (s *Float64Opt) Long(long string) (opt OptFlag)

+ func (s *Float64Opt) OwnerCommand() (opt OptCmd)

+ func (s *Float64Opt) RootCommand() (root *RootCommand)

+ func (s *Float64Opt) SetOwner(opt OptCmd)

+ func (s *Float64Opt) Short(short string) (opt OptFlag)

+ func (s *Float64Opt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *Float64Opt) ToggleGroup(group string) (opt OptFlag)

type OptFlag

+ func NewFloat32() (opt OptFlag)

+ func NewFloat64() (opt OptFlag)

type OptFlagType

+ const OptFlagTypeFloat32

+ const OptFlagTypeFloat64

type Options

+ func (s *Options) GetFloat32(key string) (ir float32)

+ func (s *Options) GetFloat64(key string) (ir float64)

type RootCmdOpt

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

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

type SubCmdOpt

+ func (s *SubCmdOpt) Float32() (opt OptFlag)

+ func (s *SubCmdOpt) Float64() (opt OptFlag)

Jun 24, 2019

Changes in this version

+ func GetDurationR(key string) time.Duration

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

+ func GetMap(key string) map[string]interface

+ func GetMapR(key string) map[string]interface

+ func SetHelpTabStop(tabStop int)

type Options

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

Jun 18, 2019

Changes in this version

+ func Soundex(s string) (snd4 string)

Jun 18, 2019

Changes in this version

+ func GetBoolR(key string) bool

+ func GetBoolRP(prefix, key string) bool

+ func GetInt64R(key string) int64

+ func GetInt64RP(prefix, key string) int64

+ func GetIntR(key string) int

+ func GetIntRP(prefix, key string) int

+ func GetIntSliceR(key string) []int

+ func GetIntSliceRP(prefix, key string) []int

+ func GetR(key string) interface

+ func GetStringR(key string) string

+ func GetStringRP(prefix, key string) string

+ func GetStringSliceR(key string) []string

+ func GetStringSliceRP(prefix, key string) []string

+ func GetUint64R(key string) uint64

+ func GetUint64RP(prefix, key string) uint64

+ func GetUintR(key string) uint

+ func GetUintRP(prefix, key string) uint

+ func SetCurrentHelpPainter(painter Painter)

+ func SetUnknownOptionHandler(handler func(isFlag bool, title string, cmd *Command, args []string))

+ func WrapWithRxxtPrefix(key string) string

Jun 3, 2019

Changes in this version

+ func IsDirectory(path string) (bool, error)

+ func IsRegularFile(path string) (bool, error)

+ func SetNoLoadConfigFiles(b bool)

Jun 1, 2019

Changes in this version

+ const ExternalToolPasswordInput

+ var SavedOsArgs []string

+ func GetDuration(key string) time.Duration

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

+ func GetIntSlice(key string) []int

+ func GetIntSliceP(prefix, key string) []int

+ func InTesting() bool

+ func LaunchEditorWith(editor string, filename string) (content []byte, err error)

+ func NormalizeDir(s string) string

+ func PrintBuildInfo()

+ func ResetOptions()

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

type Command

+ func (c *Command) GetOwner() *Command

May 30, 2019

Changes in this version

+ func SaveAsJSON(filename string) (err error)

+ func SaveAsToml(filename string) (err error)

+ func SaveAsYaml(filename string) (err error)

type CmdOpt

+ func (s *CmdOpt) Duration() (opt OptFlag)

type Command

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

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

+ type DurationOpt struct

+ func (s *DurationOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *DurationOpt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *DurationOpt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *DurationOpt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *DurationOpt) Description(oneLine, long string) (opt OptFlag)

+ func (s *DurationOpt) Examples(examples string) (opt OptFlag)

+ func (s *DurationOpt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *DurationOpt) Group(group string) (opt OptFlag)

+ func (s *DurationOpt) Hidden(hidden bool) (opt OptFlag)

+ func (s *DurationOpt) Long(long string) (opt OptFlag)

+ func (s *DurationOpt) OwnerCommand() (opt OptCmd)

+ func (s *DurationOpt) RootCommand() (root *RootCommand)

+ func (s *DurationOpt) SetOwner(opt OptCmd)

+ func (s *DurationOpt) Short(short string) (opt OptFlag)

+ func (s *DurationOpt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *DurationOpt) ToggleGroup(group string) (opt OptFlag)

type Flag

+ PostAction func(cmd *Command, args []string) (err error)

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

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

type OptCmd

+ func NewCmd() (opt OptCmd)

+ func NewCmdFrom(cmd *Command) (opt OptCmd)

+ func NewSubCmd() (opt OptCmd)

type OptFlag

+ func NewBool() (opt OptFlag)

+ func NewDuration() (opt OptFlag)

+ func NewInt() (opt OptFlag)

+ func NewInt64() (opt OptFlag)

+ func NewIntSlice() (opt OptFlag)

+ func NewString() (opt OptFlag)

+ func NewStringSlice() (opt OptFlag)

+ func NewUint() (opt OptFlag)

+ func NewUint64() (opt OptFlag)

type OptFlagType

+ const OptFlagTypeDuration

type Options

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

type RootCmdOpt

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

type SubCmdOpt

+ func (s *SubCmdOpt) Duration() (opt OptFlag)

May 30, 2019

Changes in this version

+ type BoolOpt struct

+ func (s *BoolOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *BoolOpt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *BoolOpt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *BoolOpt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *BoolOpt) Description(oneLine, long string) (opt OptFlag)

+ func (s *BoolOpt) Examples(examples string) (opt OptFlag)

+ func (s *BoolOpt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *BoolOpt) Group(group string) (opt OptFlag)

+ func (s *BoolOpt) Hidden(hidden bool) (opt OptFlag)

+ func (s *BoolOpt) Long(long string) (opt OptFlag)

+ func (s *BoolOpt) OwnerCommand() (opt OptCmd)

+ func (s *BoolOpt) RootCommand() (root *RootCommand)

+ func (s *BoolOpt) SetOwner(opt OptCmd)

+ func (s *BoolOpt) Short(short string) (opt OptFlag)

+ func (s *BoolOpt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *BoolOpt) ToggleGroup(group string) (opt OptFlag)

+ type CmdOpt struct

+ func (s *CmdOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptCmd)

+ func (s *CmdOpt) Aliases(aliases ...string) (opt OptCmd)

+ func (s *CmdOpt) Bool() (opt OptFlag)

+ func (s *CmdOpt) Deprecated(deprecation string) (opt OptCmd)

+ func (s *CmdOpt) Description(oneLine, long string) (opt OptCmd)

+ func (s *CmdOpt) Examples(examples string) (opt OptCmd)

+ func (s *CmdOpt) Group(group string) (opt OptCmd)

+ func (s *CmdOpt) Hidden(hidden bool) (opt OptCmd)

+ func (s *CmdOpt) Int() (opt OptFlag)

+ func (s *CmdOpt) Int64() (opt OptFlag)

+ func (s *CmdOpt) IntSlice() (opt OptFlag)

+ func (s *CmdOpt) Long(long string) (opt OptCmd)

+ func (s *CmdOpt) NewFlag(typ OptFlagType) (opt OptFlag)

+ func (s *CmdOpt) NewSubCommand() (opt OptCmd)

+ func (s *CmdOpt) OwnerCommand() (opt OptCmd)

+ func (s *CmdOpt) PostAction(pre func(cmd *Command, args []string)) (opt OptCmd)

+ func (s *CmdOpt) PreAction(pre func(cmd *Command, args []string) (err error)) (opt OptCmd)

+ func (s *CmdOpt) RootCommand() (root *RootCommand)

+ func (s *CmdOpt) SetOwner(opt OptCmd)

+ func (s *CmdOpt) Short(short string) (opt OptCmd)

+ func (s *CmdOpt) String() (opt OptFlag)

+ func (s *CmdOpt) StringSlice() (opt OptFlag)

+ func (s *CmdOpt) TailPlaceholder(placeholder string) (opt OptCmd)

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

+ func (s *CmdOpt) Uint() (opt OptFlag)

+ func (s *CmdOpt) Uint64() (opt OptFlag)

+ type Int64Opt struct

+ func (s *Int64Opt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *Int64Opt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *Int64Opt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *Int64Opt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *Int64Opt) Description(oneLine, long string) (opt OptFlag)

+ func (s *Int64Opt) Examples(examples string) (opt OptFlag)

+ func (s *Int64Opt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *Int64Opt) Group(group string) (opt OptFlag)

+ func (s *Int64Opt) Hidden(hidden bool) (opt OptFlag)

+ func (s *Int64Opt) Long(long string) (opt OptFlag)

+ func (s *Int64Opt) OwnerCommand() (opt OptCmd)

+ func (s *Int64Opt) RootCommand() (root *RootCommand)

+ func (s *Int64Opt) SetOwner(opt OptCmd)

+ func (s *Int64Opt) Short(short string) (opt OptFlag)

+ func (s *Int64Opt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *Int64Opt) ToggleGroup(group string) (opt OptFlag)

+ type IntOpt struct

+ func (s *IntOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *IntOpt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *IntOpt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *IntOpt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *IntOpt) Description(oneLine, long string) (opt OptFlag)

+ func (s *IntOpt) Examples(examples string) (opt OptFlag)

+ func (s *IntOpt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *IntOpt) Group(group string) (opt OptFlag)

+ func (s *IntOpt) Hidden(hidden bool) (opt OptFlag)

+ func (s *IntOpt) Long(long string) (opt OptFlag)

+ func (s *IntOpt) OwnerCommand() (opt OptCmd)

+ func (s *IntOpt) RootCommand() (root *RootCommand)

+ func (s *IntOpt) SetOwner(opt OptCmd)

+ func (s *IntOpt) Short(short string) (opt OptFlag)

+ func (s *IntOpt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *IntOpt) ToggleGroup(group string) (opt OptFlag)

+ type IntSliceOpt struct

+ func (s *IntSliceOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *IntSliceOpt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *IntSliceOpt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *IntSliceOpt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *IntSliceOpt) Description(oneLine, long string) (opt OptFlag)

+ func (s *IntSliceOpt) Examples(examples string) (opt OptFlag)

+ func (s *IntSliceOpt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *IntSliceOpt) Group(group string) (opt OptFlag)

+ func (s *IntSliceOpt) Hidden(hidden bool) (opt OptFlag)

+ func (s *IntSliceOpt) Long(long string) (opt OptFlag)

+ func (s *IntSliceOpt) OwnerCommand() (opt OptCmd)

+ func (s *IntSliceOpt) RootCommand() (root *RootCommand)

+ func (s *IntSliceOpt) SetOwner(opt OptCmd)

+ func (s *IntSliceOpt) Short(short string) (opt OptFlag)

+ func (s *IntSliceOpt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *IntSliceOpt) ToggleGroup(group string) (opt OptFlag)

+ type Opt interface

+ Action func(action func(cmd *Command, args []string) (err error)) (opt Opt)

+ Aliases func(ss ...string) (opt Opt)

+ Deprecated func(deprecation string) (opt Opt)

+ Description func(oneLine, long string) (opt Opt)

+ Examples func(examples string) (opt Opt)

+ Group func(group string) (opt Opt)

+ Hidden func(hidden bool) (opt Opt)

+ Long func(long string) (opt Opt)

+ Short func(short string) (opt Opt)

+ Titles func(short, long string, aliases ...string) (opt Opt)

+ type OptCmd interface

+ Action func(action func(cmd *Command, args []string) (err error)) (opt OptCmd)

+ Aliases func(ss ...string) (opt OptCmd)

+ Deprecated func(deprecation string) (opt OptCmd)

+ Description func(oneLine, long string) (opt OptCmd)

+ Examples func(examples string) (opt OptCmd)

+ Group func(group string) (opt OptCmd)

+ Hidden func(hidden bool) (opt OptCmd)

+ Long func(long string) (opt OptCmd)

+ NewFlag func(typ OptFlagType) (opt OptFlag)

+ NewSubCommand func() (opt OptCmd)

+ OwnerCommand func() (opt OptCmd)

+ PostAction func(post func(cmd *Command, args []string)) (opt OptCmd)

+ PreAction func(pre func(cmd *Command, args []string) (err error)) (opt OptCmd)

+ RootCommand func() *RootCommand

+ SetOwner func(opt OptCmd)

+ Short func(short string) (opt OptCmd)

+ TailPlaceholder func(placeholder string) (opt OptCmd)

+ Titles func(short, long string, aliases ...string) (opt OptCmd)

+ func Cmd() (opt OptCmd)

+ func SubCmd() (opt OptCmd)

+ type OptFlag interface

+ Action func(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ Aliases func(ss ...string) (opt OptFlag)

+ DefaultValue func(val interface{}, placeholder string) (opt OptFlag)

+ Deprecated func(deprecation string) (opt OptFlag)

+ Description func(oneLine, long string) (opt OptFlag)

+ Examples func(examples string) (opt OptFlag)

+ ExternalTool func(envKeyName string) (opt OptFlag)

+ Group func(group string) (opt OptFlag)

+ Hidden func(hidden bool) (opt OptFlag)

+ Long func(long string) (opt OptFlag)

+ OwnerCommand func() (opt OptCmd)

+ RootCommand func() *RootCommand

+ SetOwner func(opt OptCmd)

+ Short func(short string) (opt OptFlag)

+ Titles func(short, long string, aliases ...string) (opt OptFlag)

+ ToggleGroup func(group string) (opt OptFlag)

+ func Bool() (opt OptFlag)

+ func Int() (opt OptFlag)

+ func Int64() (opt OptFlag)

+ func IntSlice() (opt OptFlag)

+ func String() (opt OptFlag)

+ func StringSlice() (opt OptFlag)

+ func Uint() (opt OptFlag)

+ func Uint64() (opt OptFlag)

+ type OptFlagType int

+ const OptFlagTypeBool

+ const OptFlagTypeInt

+ const OptFlagTypeInt64

+ const OptFlagTypeIntSlice

+ const OptFlagTypeString

+ const OptFlagTypeStringSlice

+ const OptFlagTypeUint

+ const OptFlagTypeUint64

+ type RootCmdOpt struct

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

+ func (s *RootCmdOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptCmd)

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

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

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

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

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

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

+ 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) NewFlag(typ OptFlagType) (opt OptFlag)

+ func (s *RootCmdOpt) NewSubCommand() (opt OptCmd)

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

+ func (s *RootCmdOpt) PostAction(pre func(cmd *Command, args []string)) (opt OptCmd)

+ func (s *RootCmdOpt) PreAction(pre func(cmd *Command, args []string) (err error)) (opt OptCmd)

+ 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(short, long string, aliases ...string) (opt OptCmd)

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

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

+ type StringOpt struct

+ func (s *StringOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *StringOpt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *StringOpt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *StringOpt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *StringOpt) Description(oneLine, long string) (opt OptFlag)

+ func (s *StringOpt) Examples(examples string) (opt OptFlag)

+ func (s *StringOpt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *StringOpt) Group(group string) (opt OptFlag)

+ func (s *StringOpt) Hidden(hidden bool) (opt OptFlag)

+ func (s *StringOpt) Long(long string) (opt OptFlag)

+ func (s *StringOpt) OwnerCommand() (opt OptCmd)

+ func (s *StringOpt) RootCommand() (root *RootCommand)

+ func (s *StringOpt) SetOwner(opt OptCmd)

+ func (s *StringOpt) Short(short string) (opt OptFlag)

+ func (s *StringOpt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *StringOpt) ToggleGroup(group string) (opt OptFlag)

+ type StringSliceOpt struct

+ func (s *StringSliceOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *StringSliceOpt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *StringSliceOpt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *StringSliceOpt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *StringSliceOpt) Description(oneLine, long string) (opt OptFlag)

+ func (s *StringSliceOpt) Examples(examples string) (opt OptFlag)

+ func (s *StringSliceOpt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *StringSliceOpt) Group(group string) (opt OptFlag)

+ func (s *StringSliceOpt) Hidden(hidden bool) (opt OptFlag)

+ func (s *StringSliceOpt) Long(long string) (opt OptFlag)

+ func (s *StringSliceOpt) OwnerCommand() (opt OptCmd)

+ func (s *StringSliceOpt) RootCommand() (root *RootCommand)

+ func (s *StringSliceOpt) SetOwner(opt OptCmd)

+ func (s *StringSliceOpt) Short(short string) (opt OptFlag)

+ func (s *StringSliceOpt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *StringSliceOpt) ToggleGroup(group string) (opt OptFlag)

+ type SubCmdOpt struct

+ func (s *SubCmdOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptCmd)

+ func (s *SubCmdOpt) Aliases(aliases ...string) (opt OptCmd)

+ func (s *SubCmdOpt) Bool() (opt OptFlag)

+ func (s *SubCmdOpt) Deprecated(deprecation string) (opt OptCmd)

+ func (s *SubCmdOpt) Description(oneLine, long string) (opt OptCmd)

+ func (s *SubCmdOpt) Examples(examples string) (opt OptCmd)

+ func (s *SubCmdOpt) Group(group string) (opt OptCmd)

+ func (s *SubCmdOpt) Hidden(hidden bool) (opt OptCmd)

+ func (s *SubCmdOpt) Int() (opt OptFlag)

+ func (s *SubCmdOpt) Int64() (opt OptFlag)

+ func (s *SubCmdOpt) IntSlice() (opt OptFlag)

+ func (s *SubCmdOpt) Long(long string) (opt OptCmd)

+ func (s *SubCmdOpt) NewFlag(typ OptFlagType) (opt OptFlag)

+ func (s *SubCmdOpt) NewSubCommand() (opt OptCmd)

+ func (s *SubCmdOpt) OwnerCommand() (opt OptCmd)

+ func (s *SubCmdOpt) PostAction(pre func(cmd *Command, args []string)) (opt OptCmd)

+ func (s *SubCmdOpt) PreAction(pre func(cmd *Command, args []string) (err error)) (opt OptCmd)

+ func (s *SubCmdOpt) RootCommand() (root *RootCommand)

+ func (s *SubCmdOpt) SetOwner(opt OptCmd)

+ func (s *SubCmdOpt) Short(short string) (opt OptCmd)

+ func (s *SubCmdOpt) String() (opt OptFlag)

+ func (s *SubCmdOpt) StringSlice() (opt OptFlag)

+ func (s *SubCmdOpt) TailPlaceholder(placeholder string) (opt OptCmd)

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

+ func (s *SubCmdOpt) Uint() (opt OptFlag)

+ func (s *SubCmdOpt) Uint64() (opt OptFlag)

+ type Uint64Opt struct

+ func (s *Uint64Opt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *Uint64Opt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *Uint64Opt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *Uint64Opt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *Uint64Opt) Description(oneLine, long string) (opt OptFlag)

+ func (s *Uint64Opt) Examples(examples string) (opt OptFlag)

+ func (s *Uint64Opt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *Uint64Opt) Group(group string) (opt OptFlag)

+ func (s *Uint64Opt) Hidden(hidden bool) (opt OptFlag)

+ func (s *Uint64Opt) Long(long string) (opt OptFlag)

+ func (s *Uint64Opt) OwnerCommand() (opt OptCmd)

+ func (s *Uint64Opt) RootCommand() (root *RootCommand)

+ func (s *Uint64Opt) SetOwner(opt OptCmd)

+ func (s *Uint64Opt) Short(short string) (opt OptFlag)

+ func (s *Uint64Opt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *Uint64Opt) ToggleGroup(group string) (opt OptFlag)

+ type UintOpt struct

+ func (s *UintOpt) Action(action func(cmd *Command, args []string) (err error)) (opt OptFlag)

+ func (s *UintOpt) Aliases(aliases ...string) (opt OptFlag)

+ func (s *UintOpt) DefaultValue(val interface{}, placeholder string) (opt OptFlag)

+ func (s *UintOpt) Deprecated(deprecation string) (opt OptFlag)

+ func (s *UintOpt) Description(oneLine, long string) (opt OptFlag)

+ func (s *UintOpt) Examples(examples string) (opt OptFlag)

+ func (s *UintOpt) ExternalTool(envKeyName string) (opt OptFlag)

+ func (s *UintOpt) Group(group string) (opt OptFlag)

+ func (s *UintOpt) Hidden(hidden bool) (opt OptFlag)

+ func (s *UintOpt) Long(long string) (opt OptFlag)

+ func (s *UintOpt) OwnerCommand() (opt OptCmd)

+ func (s *UintOpt) RootCommand() (root *RootCommand)

+ func (s *UintOpt) SetOwner(opt OptCmd)

+ func (s *UintOpt) Short(short string) (opt OptFlag)

+ func (s *UintOpt) Titles(short, long string, aliases ...string) (opt OptFlag)

+ func (s *UintOpt) ToggleGroup(group string) (opt OptFlag)

May 28, 2019

Changes in this version

+ const DefaultEditor

+ const ExternalToolEditor

+ var EnableCmdrCommands = true

+ var GetEditor func() (string, error)

+ func GetExcutablePath() string

+ func Launch(cmd string, args ...string) (err error)

+ func LaunchEditor(editor string) (content []byte, err error)

+ func LaunchSudo(cmd string, args ...string) error

type BaseOpt

+ Deprecated string

type Command

+ Flags []*Flag

type Flag

+ DefaultValuePlaceholder string

+ ExternalTool string

+ ToggleGroup string

+ func (s *Flag) GetDescZsh() (desc string)

+ func (s *Flag) GetTitleFlagNames() string

+ func (s *Flag) GetTitleFlagNamesBy(delimChar string) string

+ func (s *Flag) GetTitleFlagNamesByMax(delimChar string, maxCount int) string

+ func (s *Flag) GetTitleZshFlagName() (str string)

+ func (s *Flag) GetTitleZshFlagNames(delimChar string) (str string)

+ func (s *Flag) GetTitleZshFlagNamesArray() (ary []string)

May 25, 2019

Changes in this version

+ func AddOnAfterXrefBuilt(cb HookXrefFunc)

+ func AddOnBeforeXrefBuilding(cb HookXrefFunc)

+ func ExecWith(rootCmd *RootCommand, beforeXrefBuilding_, afterXrefBuilt_ HookXrefFunc) (err error)

type Command

+ func (c *Command) GetHitStr() string

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

type Options

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

+ func (s *Options) GetIntSlice(key string) (ir []int)

type Painter

+ Reset func()

+ Results func() []byte

May 24, 2019

Changes in this version

+ const BgBoldOrBright

+ const BgDim

+ const BgHidden

+ const BgItalic

+ const BgNormal

+ const BgUlink

+ const BgUnderline

+ const DarkColor

+ const FgBlack

+ const FgBlue

+ const FgCyan

+ const FgDarkGray

+ const FgGreen

+ const FgLightBlue

+ const FgLightCyan

+ const FgLightGray

+ const FgLightGreen

+ const FgLightMagenta

+ const FgLightRed

+ const FgLightYellow

+ const FgMagenta

+ const FgRed

+ const FgWhite

+ const FgYellow

+ var CurrentDefaultValueColor = FgDarkGray

+ var CurrentDescColor = FgDarkGray

+ var CurrentGroupTitleColor = DarkColor

+ func StripOrderPrefix(s string) string

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

type BaseOpt

+ func (c *BaseOpt) HasParent() bool

type Command

+ func (c *Command) IsRoot() bool

+ type Painter interface

+ Flush func()

+ FpCommandsGroupTitle func(group string)

+ FpCommandsLine func(command *Command)

+ FpCommandsTitle func(command *Command)

+ FpDescLine func(command *Command)

+ FpDescTitle func(command *Command, title string)

+ FpExamplesLine func(command *Command)

+ FpExamplesTitle func(command *Command, title string)

+ FpFlagsGroupTitle func(group string)

+ FpFlagsLine func(command *Command, flag *Flag, defValStr string)

+ FpFlagsTitle func(command *Command, flag *Flag, title string)

+ FpPrintHeader func(command *Command)

+ FpPrintHelpTailLine func(command *Command)

+ FpUsagesLine func(command *Command, fmt, appName, cmdList, cmdsTitle, tailPlaceHolder string)

+ FpUsagesTitle func(command *Command, title string)

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

May 23, 2019

Changes in this version

+ func GetDebugMode() bool

+ func GetPredefinedLocations() []string

+ func GetQuietMode() bool

+ func GetStrictMode() bool

+ func GetVerboseMode() bool

+ func SetPredefinedLocations(locations []string)

type BaseOpt

+ ToggleGroup string

May 22, 2019

Changes in this version

+ const AppName

+ const SysMgmtGroup

+ const UnsortedGroup

+ var ErrShouldBeStopException = errors.New("should be stop right now")

+ var GormDefaultCopier = &CopierImpl

+ var StandardCopier = &CopierImpl

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

+ func GetBoolP(prefix, key string) bool

+ func GetInt64(key string) int64

+ func GetInt64P(prefix, key string) int64

+ func GetIntP(prefix, key string) int

+ func GetStringP(prefix, key string) string

+ func GetStringSliceP(prefix, key string) []string

+ func GetUint(key string) uint

+ func GetUint64(key string) uint64

+ func GetUint64P(prefix, key string) uint64

+ func GetUintP(prefix, key string) uint

+ func GetUsedConfigFile() string

+ func GetUsedConfigSubDir() string

+ func InternalExecFor(rootCmd *RootCommand, args []string) (err error)

+ func Set(key string, val interface{})

+ func SetCustomShowBuildInfo(fn func())

+ func SetCustomShowVersion(fn func())

+ func SetInternalOutputStreams(out, err *bufio.Writer)

+ func SetNx(key string, val interface{})

type BaseOpt

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

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

type Command

+ TailPlaceHolder string

+ type Copier interface

+ Copy func(toValue interface{}, fromValue interface{}, ignoreNames ...string) (err error)

+ type CopierImpl struct

+ KeepIfFromIsNil bool

+ KeepIfFromIsZero bool

+ ZeroIfEqualsFrom bool

+ func (s *CopierImpl) Copy(toValue interface{}, fromValue interface{}, ignoreNames ...string) (err error)

type Options

+ func (s *Options) GetUint(key string) (ir uint64)

May 15, 2019

Changes in this version

+ const APP_NAME

+ const APP_NAME_DEFAULT

+ const SYSMGMT

+ const UNSORTED_GROUP

+ const Version

+ const VersionInt

+ var EnableGenerateCommands bool = true

+ var EnableHelpCommands bool = true

+ var EnableVerboseCommands bool = true

+ var EnableVersionCommands bool = true

+ var EnvPrefix = []string

+ var RxxtOptions *Options = NewOptions()

+ var RxxtPrefix = []string

+ var ShouldBeStopException = errors.New("should be stop right now")

+ func AddOnConfigLoadedListener(c ConfigReloaded)

+ func DumpAsString() (str string)

+ func EnsureDir(dir string) (err error)

+ func Exec(rootCmd *RootCommand) (err error)

+ func FileExists(name string) bool

+ func Get(key string) interface

+ func GetBool(key string) bool

+ func GetCurrentDir() string

+ func GetExcutableDir() string

+ func GetInt(key string) int64

+ func GetString(key string) string

+ func GetStringSlice(key string) []string

+ func LoadConfigFile(file string) (err error)

+ func RemoveOnConfigLoadedListener(c ConfigReloaded)

+ func SetOnConfigLoadedListener(c ConfigReloaded, enabled bool)

+ type BaseOpt struct

+ Action func(cmd *Command, args []string) (err error)

+ Aliases []string

+ DefaultValuePlaceholder string

+ Description string

+ Examples string

+ Flags []*Flag

+ Full string

+ Group string

+ Hidden bool

+ LongDescription string

+ Name string

+ Short string

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

+ func (s *BaseOpt) GetTitleFlagNames() string

+ func (s *BaseOpt) GetTitleFlagNamesBy(delimChar string) string

+ func (s *BaseOpt) GetTitleFlagNamesByMax(delimChar string, maxCount int) string

+ func (s *BaseOpt) GetTitleName() string

+ func (s *BaseOpt) GetTitleNames() string

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

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

+ func (s *BaseOpt) GetTitleZshFlagName() (str string)

+ func (s *BaseOpt) GetTitleZshFlagNames(delimChar string) (str string)

+ func (s *BaseOpt) GetTitleZshFlagNamesArray() (ary []string)

+ type Command struct

+ PostAction func(cmd *Command, args []string)

+ PreAction func(cmd *Command, args []string) (err error)

+ SubCommands []*Command

+ func (c *Command) GetExpandableNames() string

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

+ func (c *Command) GetName() string

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

+ func (c *Command) PrintHelp(justFlags bool)

+ func (c *Command) PrintVersion()

+ type ConfigReloaded interface

+ OnConfigReloaded func()

+ type Flag struct

+ DefaultValue interface{}

+ Required bool

+ ValidArgs []string

+ type Options struct

+ func NewOptions() *Options

+ func NewOptionsWith(entries map[string]interface{}) *Options

+ func (s *Options) DumpAsString() (str string)

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

+ func (s *Options) GetBool(key string) (ret bool)

+ func (s *Options) GetInt(key string) (ir int64)

+ func (s *Options) GetString(key string) (ret string)

+ func (s *Options) GetStringSlice(key string) (ir []string)

+ func (s *Options) LoadConfigFile(file string) (err error)

+ func (s *Options) Reset()

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

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

+ type RootCommand struct

+ AppName string

+ Author string

+ Copyright string

+ Header string

+ Version string

+ VersionInt uint32