Versions in this module Expand all Collapse all v0 v0.0.1 Dec 29, 2024 Changes in this version + const BashCompCustom + const BashCompFilenameExt + const BashCompOneRequiredFlag + const BashCompSubdirsInDir + const CommandDisplayNameAnnotation + const FlagSetByCobraAnnotation + const ShellCompNoDescRequestCmd + const ShellCompRequestCmd + var EnableCaseInsensitive = defaultCaseInsensitive + var EnableCommandSorting = defaultCommandSorting + var EnablePrefixMatching = defaultPrefixMatching + var EnableTraverseRunHooks = defaultTraverseRunHooks + var MousetrapDisplayDuration = 5 * time.Second + var MousetrapHelpText = ... + func AddTemplateFunc(name string, tmplFunc interface{}) + func AddTemplateFuncs(tmplFuncs template.FuncMap) + func AllChildCommandsHaveGroup(c Commander) bool + func AppendActiveHelp(compArray []string, activeHelpStr string) []string + func ArbitraryArgs(cmd Commander, args []string) error + func ArgsLenAtDash(c Commander) int + func Bind(main Commander, commands ...Commander) + func CalledAs(c Commander) string + func CheckCommandGroups(c Commander) + func CheckErr(msg interface{}) + func CommandPath(c Commander) string + func CommandPathPadding(c Commander) int + func CompDebug(msg string, printToStdErr bool) + func CompDebugln(msg string, printToStdErr bool) + func CompError(msg string) + func CompErrorln(msg string) + func ContainsGroup(c Commander, groupID string) bool + func DebugFlags(c Commander) + func Eq(a interface{}, b interface{}) bool + func Execute(c Commander) error + func FixedCompletions(choices []string, directive ShellCompDirective) ... + func Flag(c Commander, name string) (flag *flag.Flag) + func FlagErrorFunc(c Commander) (f func(Commander, error) error) + func Flags(c Commander) *flag.FlagSet + func GenBashCompletionFileV2(c Commander, filename string, includeDesc bool) error + func GenBashCompletionV2(c Commander, w io.Writer, includeDesc bool) error + func GenFishCompletion(c Commander, w io.Writer, includeDesc bool) error + func GenFishCompletionFile(c Commander, filename string, includeDesc bool) error + func GenPowerShellCompletion(c Commander, w io.Writer) error + func GenPowerShellCompletionFile(c Commander, filename string) error + func GenPowerShellCompletionFileWithDesc(c Commander, filename string) error + func GenPowerShellCompletionWithDesc(c Commander, w io.Writer) error + func GenZshCompletion(c Commander, w io.Writer) error + func GenZshCompletionFile(c Commander, filename string) error + func GenZshCompletionFileNoDesc(c Commander, filename string) error + func GenZshCompletionNoDesc(c Commander, w io.Writer) error + func GetActiveHelpConfig(cmd Commander) string + func Gt(a interface{}, b interface{}) bool + func HasAlias(c Commander, s string) bool + func HasAvailableFlags(c Commander) bool + func HasAvailableInheritedFlags(c Commander) bool + func HasAvailableLocalFlags(c Commander) bool + func HasAvailablePersistentFlags(c Commander) bool + func HasAvailableSubCommands(c Commander) bool + func HasExample(c Commander) bool + func HasFlags(c Commander) bool + func HasHelpSubCommands(c Commander) bool + func HasInheritedFlags(c Commander) bool + func HasLocalFlags(c Commander) bool + func HasParent(c Commander) bool + func HasPersistentFlags(c Commander) bool + func HasSubCommands(c Commander) bool + func Help(c Commander) error + func HelpFunc(c Commander, a []string) + func HelpTemplate(c Commander) string + func InheritedFlagUsages(c Commander) string + func InheritedFlags(c Commander) *flag.FlagSet + func InitDefaultCompletionCmd(c Commander) + func InitDefaultHelpCmd(c Commander) + func InitDefaultHelpFlag(c Commander) + func InitDefaultVersionFlag(c Commander) + func IsAdditionalHelpTopicCommand(c Commander) bool + func IsAvailableCommand(c Commander) bool + func LocalFlagUsages(c Commander) string + func LocalFlags(c Commander) *flag.FlagSet + func LocalNonPersistentFlags(c Commander) *flag.FlagSet + func MarkFlagCustom(flags *flag.FlagSet, name string, f string) error + func MarkFlagDirname(flags *flag.FlagSet, name string) error + func MarkFlagFilename(flags *flag.FlagSet, name string, extensions ...string) error + func MarkFlagRequired(c Commander, name string) error + func MarkFlagsMutuallyExclusive(c Commander, flagNames ...string) + func MarkFlagsOneRequired(c Commander, flagNames ...string) + func MarkFlagsRequiredTogether(c Commander, flagNames ...string) + func MarkPersistentFlagFilename(c Commander, name string, extensions ...string) error + func MarkPersistentFlagRequired(c Commander, name string) error + func MarkZshCompPositionalArgumentFile(c Commander, argPosition int, patterns ...string) error + func MarkZshCompPositionalArgumentWords(c Commander, argPosition int, words ...string) error + func NamePadding(c Commander) int + func NoArgs(cmd Commander, args []string) error + func NonInheritedFlags(c Commander) *flag.FlagSet + func OnFinalize(y ...func()) + func OnInitialize(y ...func()) + func OnlyValidArgs(cmd Commander, args []string) error + func ParseFlags(c Commander, args []string) error + func ParseName(c Commander) string + func PersistentFlags(c Commander) *flag.FlagSet + func RemoveCommand(c Commander, cmds ...Commander) + func Run(root Commander, commands ...Commander) error + func SetGlobalNormalizationFunc(c Commander, n func(f *flag.FlagSet, name string) flag.NormalizedName) + func SuggestionsFor(c Commander, typedName string) []string + func Usage(c Commander) error + func UsagePadding(c Commander) int + func UsageString(c Commander) string + func UsageTemplate(c Commander) string + func UseLine(c Commander) string + func ValidateArgs(c Commander, args []string) error + func ValidateFlagGroups(c Commander) error + func ValidateRequiredFlags(c Commander) error + func VersionTemplate(c Commander) string + func VisitParents(c Commander, fn func(Commander)) + func WriteStringAndCheck(b io.StringWriter, s string) + type BashCompleteCmd struct + func NewBashCompleteCmd(cmd Commander, shortDesc string) *BashCompleteCmd + func (cmd *BashCompleteCmd) GetUse() string + func (cmd *BashCompleteCmd) Run(args []string) error + type Command struct + Aliases []string + Annotations map[string]string + ArgAliases []string + Args PositionalArgs + BashCompletionFunction string + CompletionOptions CompletionOptions + Deprecated string + DisableAutoGenTag bool + DisableFlagParsing bool + DisableFlagsInUseLine bool + DisableSuggestions bool + Example string + FParseErrWhitelist FParseErrWhitelist + GroupID string + Hidden bool + Long string + PersistentPostRun func(cmd Commander, args []string) + PersistentPostRunE func(cmd Commander, args []string) error + PersistentPreRun func(cmd Commander, args []string) + PersistentPreRunE func(cmd Commander, args []string) error + PostRunE func(cmd Commander, args []string) error + PreRunE func(cmd Commander, args []string) error + RunE func(cmd Commander, args []string) error + Short string + SilenceErrors bool + SilenceUsage bool + SuggestFor []string + SuggestionsMinimumDistance int + TraverseChildren bool + Use string + ValidArgs []string + ValidArgsFunction func(cmd Commander, args []string, toComplete string) ([]string, ShellCompDirective) + Version string + func Root(use string, commands ...Commander) *Command + func (c *Command) Add(v ...Commander) + func (c *Command) Exec(args ...string) error + func (c *Command) Execute() error + func (c *Command) GenBashCompletion(w io.Writer) error + func (c *Command) GenBashCompletionFile(filename string) error + func (c *Command) GetAliases() []string + func (c *Command) GetAnnotations() map[string]string + func (c *Command) GetArgAliases() []string + func (c *Command) GetCompletionOptions() *CompletionOptions + func (c *Command) GetDeprecated() string + func (c *Command) GetDisableAutoGenTag() bool + func (c *Command) GetDisableFlagParsing() bool + func (c *Command) GetDisableFlagsInUseLine() bool + func (c *Command) GetDisableSuggestions() bool + func (c *Command) GetExample() string + func (c *Command) GetFParseErrWhitelist() FParseErrWhitelist + func (c *Command) GetFlagCompletionFunc(flagName string) (func(Commander, []string, string) ([]string, ShellCompDirective), bool) + func (c *Command) GetGlobNormFunc() func(f *flag.FlagSet, name string) flag.NormalizedName + func (c *Command) GetGroupID() string + func (c *Command) GetHidden() bool + func (c *Command) GetLong() string + func (c *Command) GetPersistentPostRun() func(cmd Commander, args []string) + func (c *Command) GetPersistentPostRunE() func(cmd Commander, args []string) error + func (c *Command) GetPositionalArgs() PositionalArgs + func (c *Command) GetShort() string + func (c *Command) GetSilenceErrors() bool + func (c *Command) GetSilenceUsage() bool + func (c *Command) GetSuggestFor() []string + func (c *Command) GetTraverseChildren() bool + func (c *Command) GetUse() string + func (c *Command) GetValidArgs() []string + func (c *Command) GetValidArgsFunction() ... + func (c *Command) GetVersion() string + func (c *Command) GlobalNormalizationFunc() func(f *flag.FlagSet, name string) flag.NormalizedName + func (c *Command) MarkFlagCustom(name string, f string) error + func (c *Command) MarkFlagDirname(name string) error + func (c *Command) MarkFlagFilename(name string, extensions ...string) error + func (c *Command) MarkPersistentFlagDirname(name string) error + func (c *Command) Parent() Commander + func (c *Command) PostExec(args []string) error + func (c *Command) PreExec(args []string) error + func (c *Command) RegisterFlagCompletionFunc(flagName string, ...) error + func (c *Command) Runnable() bool + func (c *Command) SetDisableAutoGenTag(d bool) + func (c *Command) SetFParseErrWhitelist(fp FParseErrWhitelist) + func (c *Command) SetGlobNormFunc(f func(f *flag.FlagSet, name string) flag.NormalizedName) + func (c *Command) SetGroupID(groupID string) + func (c *Command) SetVersionTemplate(s string) + type CommandCalledAs struct + type Commander interface + Commands func() []Commander + Context func() context.Context + ErrPrefix func() string + Exec func(args ...string) error + GetAliases func() []string + GetAnnotations func() map[string]string + GetArgAliases func() []string + GetArgs func() []string + GetCommandCalledAs func() *CommandCalledAs + GetCommandGroups func() []*Group + GetCommandsMaxCommandPathLen func() int + GetCommandsMaxNameLen func() int + GetCommandsMaxUseLen func() int + GetCompletionCommandGroupID func() string + GetCompletionOptions func() *CompletionOptions + GetDeprecated func() string + GetDisableAutoGenTag func() bool + GetDisableFlagParsing func() bool + GetDisableFlagsInUseLine func() bool + GetDisableSuggestions func() bool + GetExample func() string + GetFParseErrWhitelist func() FParseErrWhitelist + GetFlagErrorBuf func() *bytes.Buffer + GetFlagErrorFunc func() func(Commander, error) error + GetFlags func() *flag.FlagSet + GetGlobNormFunc func() func(f *flag.FlagSet, name string) flag.NormalizedName + GetGroupID func() string + GetHelpCommand func() Commander + GetHidden func() bool + GetIFlags func() *flag.FlagSet + GetLFlags func() *flag.FlagSet + GetLong func() string + GetPFlags func() *flag.FlagSet + GetParentsPFlags func() *flag.FlagSet + GetPositionalArgs func() PositionalArgs + GetShort func() string + GetSilenceErrors func() bool + GetSilenceUsage func() bool + GetSuggestFor func() []string + GetSuggestionsMinimumDistance func() int + GetTraverseChildren func() bool + GetUse func() string + GetValidArgs func() []string + GetValidArgsFunction func() ... + GetVersion func() string + Init func() + Parent func() Commander + PersistentPostExec func(args []string) error + PersistentPreExec func(args []string) error + PostExec func(args []string) error + PreExec func(args []string) error + Runnable func() bool + SetCommands func(...Commander) + SetCommandsAreSorted func(v bool) + SetCommandsMaxCommandPathLen func(v int) + SetCommandsMaxNameLen func(v int) + SetCommandsMaxUseLen func(v int) + SetCompletionCommandGroupID func(v string) + SetContext func(ctx context.Context) + SetDisableAutoGenTag func(d bool) + SetFParseErrWhitelist func(FParseErrWhitelist) + SetFlagErrorBuf func(*bytes.Buffer) + SetFlags func(*flag.FlagSet) + SetGlobNormFunc func(f func(f *flag.FlagSet, name string) flag.NormalizedName) + SetGroupID func(groupID string) + SetIFlags func(*flag.FlagSet) + SetLFlags func(*flag.FlagSet) + SetPFlags func(*flag.FlagSet) + SetParent func(Commander) + SetParentsPFlags func(*flag.FlagSet) + func Base(c Commander) Commander + func ExecuteC(c Commander) (cmd Commander, err error) + func Find(c Commander, args []string) (Commander, []string, error) + func Func(use string, exec func(args ...string) error) Commander + func Traverse(c Commander, args []string) (Commander, []string, error) + type CompleteCmd struct + func NewCompleteCmd(cmd Commander) *CompleteCmd + func (cmd *CompleteCmd) GetUse() string + func (cmd *CompleteCmd) Run(args []string) error + type CompletionOptions struct + DisableDefaultCmd bool + DisableDescriptions bool + DisableNoDescFlag bool + HiddenDefaultCmd bool + type Default struct + func (d *Default) AddGroup(groups ...*Group) + func (d *Default) CommandPathPadding() int + func (d *Default) Commands() []Commander + func (d *Default) ContainsGroup(groupID string) bool + func (d *Default) Context() context.Context + func (d *Default) ErrPrefix() string + func (d *Default) GetAliases() []string + func (d *Default) GetAnnotations() map[string]string + func (d *Default) GetArgAliases() []string + func (d *Default) GetArgs() []string + func (d *Default) GetCommandCalledAs() *CommandCalledAs + func (d *Default) GetCommandGroups() []*Group + func (d *Default) GetCommands() []Commander + func (d *Default) GetCommandsMaxCommandPathLen() int + func (d *Default) GetCommandsMaxNameLen() int + func (d *Default) GetCommandsMaxUseLen() int + func (d *Default) GetCompletionCommandGroupID() string + func (d *Default) GetCompletionOptions() *CompletionOptions + func (d *Default) GetDeprecated() string + func (d *Default) GetDisableAutoGenTag() bool + func (d *Default) GetDisableFlagParsing() bool + func (d *Default) GetDisableFlagsInUseLine() bool + func (d *Default) GetDisableSuggestions() bool + func (d *Default) GetExample() string + func (d *Default) GetFParseErrWhitelist() FParseErrWhitelist + func (d *Default) GetFlagErrorBuf() *bytes.Buffer + func (d *Default) GetFlagErrorFunc() func(Commander, error) error + func (d *Default) GetFlags() *flag.FlagSet + func (d *Default) GetGlobNormFunc() func(f *flag.FlagSet, name string) flag.NormalizedName + func (d *Default) GetGroupID() string + func (d *Default) GetHelpCommand() Commander + func (d *Default) GetHidden() bool + func (d *Default) GetIFlags() *flag.FlagSet + func (d *Default) GetLFlags() *flag.FlagSet + func (d *Default) GetLong() string + func (d *Default) GetPFlags() *flag.FlagSet + func (d *Default) GetParentsPFlags() *flag.FlagSet + func (d *Default) GetPositionalArgs() PositionalArgs + func (d *Default) GetShort() string + func (d *Default) GetSilenceErrors() bool + func (d *Default) GetSilenceUsage() bool + func (d *Default) GetSuggestFor() []string + func (d *Default) GetSuggestionsMinimumDistance() int + func (d *Default) GetTraverseChildren() bool + func (d *Default) GetValidArgs() []string + func (d *Default) GetValidArgsFunction() ... + func (d *Default) GetVersion() string + func (d *Default) GlobalNormalizationFunc() func(f *flag.FlagSet, name string) flag.NormalizedName + func (d *Default) Groups() []*Group + func (d *Default) Init() + func (d *Default) Parent() Commander + func (d *Default) PersistentPostExec(args []string) error + func (d *Default) PersistentPreExec(args []string) error + func (d *Default) PostExec(args []string) error + func (d *Default) PreExec(args []string) error + func (d *Default) ResetCommands() + func (d *Default) Runnable() bool + func (d *Default) SetArgs(a ...string) + func (d *Default) SetCommands(v ...Commander) + func (d *Default) SetCommandsAreSorted(v bool) + func (d *Default) SetCommandsMaxCommandPathLen(v int) + func (d *Default) SetCommandsMaxNameLen(v int) + func (d *Default) SetCommandsMaxUseLen(v int) + func (d *Default) SetCompletionCommandGroupID(groupID string) + func (d *Default) SetContext(ctx context.Context) + func (d *Default) SetDisableAutoGenTag(v bool) + func (d *Default) SetFParseErrWhitelist(fp FParseErrWhitelist) + func (d *Default) SetFlagErrorBuf(b *bytes.Buffer) + func (d *Default) SetFlagErrorFunc(f func(Commander, error) error) + func (d *Default) SetFlags(f *flag.FlagSet) + func (d *Default) SetGlobNormFunc(f func(f *flag.FlagSet, name string) flag.NormalizedName) + func (d *Default) SetGroupID(groupID string) + func (d *Default) SetHelpCommand(cmd Commander) + func (d *Default) SetHelpCommandGroupID(groupID string) + func (d *Default) SetIFlags(i *flag.FlagSet) + func (d *Default) SetLFlags(l *flag.FlagSet) + func (d *Default) SetPFlags(l *flag.FlagSet) + func (d *Default) SetParent(c Commander) + func (d *Default) SetParentsPFlags(pf *flag.FlagSet) + func (d *Default) SetSuggestionsMinimumDistance(v int) + type FParseErrWhitelist flag.ParseErrorsWhitelist + type FishCompleteCmd struct + func NewFishCompleteCmd(cmd Commander, shortDesc string, noDesc bool) *FishCompleteCmd + func (p *FishCompleteCmd) GetUse() string + func (p *FishCompleteCmd) Run(args []string) error + type Group struct + ID string + Title string + type HelpCmd struct + func NewHelpCmd(cmd Commander) *HelpCmd + func (p *HelpCmd) GetUse() string + func (p *HelpCmd) Run(args []string) error + type PositionalArgs func(cmd Commander, args []string) error + func ExactArgs(n int) PositionalArgs + func ExactValidArgs(n int) PositionalArgs + func MatchAll(pargs ...PositionalArgs) PositionalArgs + func MaximumNArgs(n int) PositionalArgs + func MinimumNArgs(n int) PositionalArgs + func RangeArgs(min int, max int) PositionalArgs + type PowershellCompleteCmd struct + func NewPowershellCompleteCmd(cmd Commander, shortDesc string, noDesc bool) *PowershellCompleteCmd + func (cmd *PowershellCompleteCmd) GetUse() string + func (cmd *PowershellCompleteCmd) Run(args []string) error + type Print struct + func (c *Print) ErrOrStderr() io.Writer + func (c *Print) GetIn() io.Reader + func (c *Print) GetOut() io.Writer + func (c *Print) InOrStdin() io.Reader + func (c *Print) OutOrStderr() io.Writer + func (c *Print) OutOrStdout() io.Writer + func (c *Print) Print(i ...interface{}) + func (c *Print) PrintErr(i ...interface{}) + func (c *Print) PrintErrF(format string, i ...interface{}) + func (c *Print) PrintErrLn(i ...interface{}) + func (c *Print) Printf(format string, i ...interface{}) + func (c *Print) Println(i ...interface{}) + func (c *Print) SetErr(newErr io.Writer) + func (c *Print) SetIn(newIn io.Reader) + func (c *Print) SetOut(newOut io.Writer) + func (c *Print) SetOutput(output io.Writer) + type ShellCompDirective int + const ShellCompDirectiveDefault + const ShellCompDirectiveError + const ShellCompDirectiveFilterDirs + const ShellCompDirectiveFilterFileExt + const ShellCompDirectiveKeepOrder + const ShellCompDirectiveNoFileComp + const ShellCompDirectiveNoSpace + func NoFileCompletions(cmd Commander, args []string, toComplete string) ([]string, ShellCompDirective) + type ZshCompleteCmd struct + func NewZshCompleteCmd(cmd Commander, shortDesc string, noDesc bool) *ZshCompleteCmd + func (p *ZshCompleteCmd) GetUse() string + func (p *ZshCompleteCmd) Run(args []string) error
Go to main page