cobra package - github.com/spf13/cobra - Go Packages (original) (raw)

Package cobra is a commander providing a simple interface to create powerful modern CLI interfaces. In addition to providing an interface, Cobra simultaneously provides a controller to organize your application code.

View Source

const ( BashCompFilenameExt = "cobra_annotation_bash_completion_filename_extensions" BashCompCustom = "cobra_annotation_bash_completion_custom" BashCompOneRequiredFlag = "cobra_annotation_bash_completion_one_required_flag" BashCompSubdirsInDir = "cobra_annotation_bash_completion_subdirs_in_dir" )

Annotations for Bash completion.

View Source

const ( FlagSetByCobraAnnotation = "cobra_annotation_flag_set_by_cobra" CommandDisplayNameAnnotation = "cobra_annotation_command_display_name" )

View Source

const (

ShellCompRequestCmd = "__complete"


ShellCompNoDescRequestCmd = "__completeNoDesc"

)

View Source

var EnableCaseInsensitive = defaultCaseInsensitive

EnableCaseInsensitive allows case-insensitive commands names. (case sensitive by default)

View Source

var EnableCommandSorting = defaultCommandSorting

EnableCommandSorting controls sorting of the slice of commands, which is turned on by default. To disable sorting, set it to false.

View Source

var EnablePrefixMatching = defaultPrefixMatching

EnablePrefixMatching allows setting automatic prefix matching. Automatic prefix matching can be a dangerous thing to automatically enable in CLI tools. Set this to true to enable it.

View Source

var EnableTraverseRunHooks = defaultTraverseRunHooks

EnableTraverseRunHooks executes persistent pre-run and post-run hooks from all parents. By default this is disabled, which means only the first run hook to be found is executed.

MousetrapDisplayDuration controls how long the MousetrapHelpText message is displayed on Windows if the CLI is started from explorer.exe. Set to 0 to wait for the return key to be pressed. To disable the mousetrap, just set MousetrapHelpText to blank string (""). Works only on Microsoft Windows.

View Source

var MousetrapHelpText = `This is a command line tool.

You need to open cmd.exe and run it from there. `

MousetrapHelpText enables an information splash screen on Windows if the CLI is started from explorer.exe. To disable the mousetrap, just set this variable to blank string (""). Works only on Microsoft Windows.

func AddTemplateFunc(name string, tmplFunc interface{})

AddTemplateFunc adds a template function that's available to Usage and Help template generation.

AddTemplateFuncs adds multiple template functions that are available to Usage and Help template generation.

ArbitraryArgs never returns an error.

func CheckErr(msg interface{})

CheckErr prints the msg with the prefix 'Error:' and exits with error code 1. If the msg is nil, it does nothing.

CompDebug prints the specified string to the same file as where the completion script prints its logs. Note that completion printouts should never be on stdout as they would be wrongly interpreted as actual completion choices by the completion script.

CompDebugln prints the specified string with a newline at the end to the same file as where the completion script prints its logs. Such logs are only printed when the user has set the environment variable BASH_COMP_DEBUG_FILE to the path of some file to be used.

CompError prints the specified completion message to stderr.

CompErrorln prints the specified completion message to stderr with a newline at the end.

func Eq(a interface{}, b interface{}) bool

Eq takes two types and checks whether they are equal. Supported types are int and string. Unsupported types will panic.

func GetActiveHelpConfig(cmd *Command) string

GetActiveHelpConfig returns the value of the ActiveHelp environment variable _ACTIVE_HELP where is the name of the root command in upper case, with all non-ASCII-alphanumeric characters replaced by `_`. It will always return "0" if the global environment variable COBRA_ACTIVE_HELP is set to "0".

func Gt(a interface{}, b interface{}) bool

Gt takes two types and checks whether the first type is greater than the second. In case of types Arrays, Chans, Maps and Slices, Gt will compare their lengths. Ints are compared directly while strings are first parsed as ints and then compared.

MarkFlagCustom adds the BashCompCustom annotation to the named flag, if it exists. The bash completion script will call the bash function f for the flag.

This will only work for bash completion. It is recommended to instead use c.RegisterFlagCompletionFunc(...) which allows to register a Go function which will work across all shells.

MarkFlagDirname instructs the various shell completion implementations to limit completions for the named flag to directory names.

MarkFlagFilename instructs the various shell completion implementations to limit completions for the named flag to the specified file extensions.

MarkFlagRequired instructs the various shell completion implementations to prioritize the named flag when performing completion, and causes your command to report an error if invoked without the flag.

NoArgs returns an error if any args are included.

NoFileCompletions can be used to disable file completion for commands that should not trigger file completions.

This method satisfies CompletionFunc. It can be used with Command.RegisterFlagCompletionFunc and for [Command.ValidArgsFunction].

func OnFinalize(y ...func())

OnFinalize sets the passed functions to be run when each command's Execute method is terminated.

func OnInitialize(y ...func())

OnInitialize sets the passed functions to be run when each command's Execute method is called.

OnlyValidArgs returns an error if there are any positional args that are not in the `ValidArgs` field of `Command`

func WriteStringAndCheck added in v1.1.2

WriteStringAndCheck writes a string into a buffer, and checks if the error is not nil.

type Command

type Command struct {

Use [string](/builtin#string)


Aliases [][string](/builtin#string)


SuggestFor [][string](/builtin#string)


Short [string](/builtin#string)


GroupID [string](/builtin#string)


Long [string](/builtin#string)


Example [string](/builtin#string)


ValidArgs [][Completion](#Completion)


ValidArgsFunction [CompletionFunc](#CompletionFunc)


Args [PositionalArgs](#PositionalArgs)


ArgAliases [][string](/builtin#string)


BashCompletionFunction [string](/builtin#string)


Deprecated [string](/builtin#string)


Annotations map[[string](/builtin#string)][string](/builtin#string)


Version [string](/builtin#string)


PersistentPreRun func(cmd *[Command](#Command), args [][string](/builtin#string))

PersistentPreRunE func(cmd *[Command](#Command), args [][string](/builtin#string)) [error](/builtin#error)

PreRun func(cmd *[Command](#Command), args [][string](/builtin#string))

PreRunE func(cmd *[Command](#Command), args [][string](/builtin#string)) [error](/builtin#error)

Run func(cmd *[Command](#Command), args [][string](/builtin#string))

RunE func(cmd *[Command](#Command), args [][string](/builtin#string)) [error](/builtin#error)

PostRun func(cmd *[Command](#Command), args [][string](/builtin#string))

PostRunE func(cmd *[Command](#Command), args [][string](/builtin#string)) [error](/builtin#error)

PersistentPostRun func(cmd *[Command](#Command), args [][string](/builtin#string))

PersistentPostRunE func(cmd *[Command](#Command), args [][string](/builtin#string)) [error](/builtin#error)


FParseErrWhitelist [FParseErrWhitelist](#FParseErrWhitelist)


CompletionOptions [CompletionOptions](#CompletionOptions)


TraverseChildren [bool](/builtin#bool)


Hidden [bool](/builtin#bool)


SilenceErrors [bool](/builtin#bool)


SilenceUsage [bool](/builtin#bool)


DisableFlagParsing [bool](/builtin#bool)


DisableAutoGenTag [bool](/builtin#bool)


DisableFlagsInUseLine [bool](/builtin#bool)


DisableSuggestions [bool](/builtin#bool)


SuggestionsMinimumDistance [int](/builtin#int)

}

Command is just that, a command for your application. E.g. 'go run ...' - 'run' is the command. Cobra requires you to define the usage and description as part of your command definition to ensure usability.

func (*Command) AddCommand

func (c Command) AddCommand(cmds ...Command)

AddCommand adds one or more commands to this parent command.

func (*Command) AddGroup added in v1.6.0

func (c Command) AddGroup(groups ...Group)

AddGroup adds one or more command groups to this parent command.

func (*Command) AllChildCommandsHaveGroup added in v1.6.0

func (c *Command) AllChildCommandsHaveGroup() bool

AllChildCommandsHaveGroup returns if all subcommands are assigned to a group

func (*Command) ArgsLenAtDash

func (c *Command) ArgsLenAtDash() int

ArgsLenAtDash will return the length of c.Flags().Args at the moment when a -- was found during args parsing.

func (*Command) CalledAs added in v0.0.2

CalledAs returns the command name or alias that was used to invoke this command or an empty string if the command has not been called.

func (*Command) CommandPath

CommandPath returns the full path to this command.

func (*Command) CommandPathPadding

func (c *Command) CommandPathPadding() int

CommandPathPadding return padding for the command path.

func (*Command) Commands

func (c Command) Commands() []Command

Commands returns a sorted slice of child commands.

func (*Command) ContainsGroup added in v1.6.0

ContainsGroup return if groupID exists in the list of command groups.

func (*Command) Context added in v0.0.6

Context returns underlying command context. If command was executed with ExecuteContext or the context was set with SetContext, the previously set context will be returned. Otherwise, nil is returned.

Notice that a call to Execute and ExecuteC will replace a nil context of a command with a context.Background, so a background context will be returned by Context after one of these functions has been called.

func (*Command) DebugFlags

func (c *Command) DebugFlags()

DebugFlags used to determine which flags have been assigned to which commands and which persist.

func (*Command) DisplayName added in v1.9.0

DisplayName returns the name to display in help text. Returns command Name() If CommandDisplayNameAnnoation is not set

func (*Command) ErrOrStderr added in v0.0.5

ErrOrStderr returns output to stderr

func (*Command) ErrPrefix added in v1.8.0

ErrPrefix return error message prefix for the command

func (*Command) Execute

Execute uses the args (os.Args[1:] by default) and run through the command tree finding appropriate matches for commands and then corresponding flags.

func (*Command) ExecuteC

func (c *Command) ExecuteC() (cmd *Command, err error)

ExecuteC executes the command.

func (*Command) ExecuteContext added in v0.0.6

ExecuteContext is the same as Execute(), but sets the ctx on the command. Retrieve ctx by calling cmd.Context() inside your *Run lifecycle or ValidArgs functions.

func (*Command) ExecuteContextC added in v1.2.0

ExecuteContextC is the same as ExecuteC(), but sets the ctx on the command. Retrieve ctx by calling cmd.Context() inside your *Run lifecycle or ValidArgs functions.

func (*Command) Find

Find the target command given the args and command tree Meant to be run on the highest node. Only searches down.

func (*Command) Flag

Flag climbs up the command tree looking for matching flag.

func (*Command) FlagErrorFunc

FlagErrorFunc returns either the function set by SetFlagErrorFunc for this command or a parent, or it returns a function which returns the original error.

func (*Command) Flags

Flags returns the complete FlagSet that applies to this command (local and persistent declared here and by all parents).

func (*Command) GenBashCompletion

GenBashCompletion generates bash completion file and writes to the passed writer.

func (*Command) GenBashCompletionFileV2 added in v1.2.0

GenBashCompletionFileV2 generates Bash completion version 2.

func (*Command) GenBashCompletionV2 added in v1.2.0

GenBashCompletionV2 generates Bash completion file version 2 and writes it to the passed writer.

func (*Command) GenFishCompletion added in v1.0.0

GenFishCompletion generates fish completion file and writes to the passed writer.

func (*Command) GenFishCompletionFile added in v1.0.0

GenFishCompletionFile generates fish completion file.

func (*Command) GenPowerShellCompletion added in v0.0.5

GenPowerShellCompletion generates powershell completion file without descriptions and writes it to the passed writer.

func (*Command) GenPowerShellCompletionFile added in v0.0.5

func (c *Command) GenPowerShellCompletionFile(filename string) error

GenPowerShellCompletionFile generates powershell completion file without descriptions.

func (*Command) GenPowerShellCompletionWithDesc added in v1.1.2

GenPowerShellCompletionWithDesc generates powershell completion file with descriptions and writes it to the passed writer.

func (*Command) GenZshCompletion

GenZshCompletion generates zsh completion file including descriptions and writes it to the passed writer.

func (*Command) GenZshCompletionFile

GenZshCompletionFile generates zsh completion file including descriptions.

func (*Command) GenZshCompletionFileNoDesc added in v1.1.0

func (c *Command) GenZshCompletionFileNoDesc(filename string) error

GenZshCompletionFileNoDesc generates zsh completion file without descriptions.

func (*Command) GenZshCompletionNoDesc added in v1.1.0

GenZshCompletionNoDesc generates zsh completion file without descriptions and writes it to the passed writer.

func (*Command) GetFlagCompletionFunc added in v1.8.0

GetFlagCompletionFunc returns the completion function for the given flag of the command, if available.

func (*Command) GlobalNormalizationFunc

GlobalNormalizationFunc returns the global normalization function or nil if it doesn't exist.

func (*Command) Groups added in v1.6.0

func (c Command) Groups() []Group

Groups returns a slice of child command groups.

func (*Command) HasAlias

HasAlias determines if a given string is an alias of the command.

func (*Command) HasAvailableFlags

func (c *Command) HasAvailableFlags() bool

HasAvailableFlags checks if the command contains any flags (local plus persistent from the entire structure) which are not hidden or deprecated.

func (*Command) HasAvailableInheritedFlags

func (c *Command) HasAvailableInheritedFlags() bool

HasAvailableInheritedFlags checks if the command has flags inherited from its parent command which are not hidden or deprecated.

func (*Command) HasAvailableLocalFlags

func (c *Command) HasAvailableLocalFlags() bool

HasAvailableLocalFlags checks if the command has flags specifically declared locally which are not hidden or deprecated.

func (*Command) HasAvailablePersistentFlags

func (c *Command) HasAvailablePersistentFlags() bool

HasAvailablePersistentFlags checks if the command contains persistent flags which are not hidden or deprecated.

func (*Command) HasAvailableSubCommands

func (c *Command) HasAvailableSubCommands() bool

HasAvailableSubCommands determines if a command has available sub commands that need to be shown in the usage/help default template under 'available commands'.

func (*Command) HasExample

func (c *Command) HasExample() bool

HasExample determines if the command has example.

func (*Command) HasFlags

func (c *Command) HasFlags() bool

HasFlags checks if the command contains any flags (local plus persistent from the entire structure).

func (*Command) HasHelpSubCommands

func (c *Command) HasHelpSubCommands() bool

HasHelpSubCommands determines if a command has any available 'help' sub commands that need to be shown in the usage/help default template under 'additional help topics'.

func (*Command) HasInheritedFlags

func (c *Command) HasInheritedFlags() bool

HasInheritedFlags checks if the command has flags inherited from its parent command.

func (*Command) HasLocalFlags

func (c *Command) HasLocalFlags() bool

HasLocalFlags checks if the command has flags specifically declared locally.

func (*Command) HasParent

func (c *Command) HasParent() bool

HasParent determines if the command is a child command.

func (*Command) HasPersistentFlags

func (c *Command) HasPersistentFlags() bool

HasPersistentFlags checks if the command contains persistent flags.

func (*Command) HasSubCommands

func (c *Command) HasSubCommands() bool

HasSubCommands determines if the command has children commands.

func (*Command) Help

Help puts out the help for the command. Used when a user calls help [command]. Can be defined by user by overriding HelpFunc.

func (*Command) HelpFunc

func (c Command) HelpFunc() func(Command, []string)

HelpFunc returns either the function set by SetHelpFunc for this command or a parent, or it returns a function with default help behavior.

func (*Command) HelpTemplate

HelpTemplate return help template for the command. This function is kept for backwards-compatibility reasons.

func (*Command) InOrStdin added in v0.0.5

InOrStdin returns input to stdin

func (*Command) InheritedFlags

InheritedFlags returns all flags which were inherited from parent commands. This function does not modify the flags of the current command, it's purpose is to return the current state.

func (*Command) InitDefaultCompletionCmd added in v1.6.0

func (c *Command) InitDefaultCompletionCmd(args ...string)

InitDefaultCompletionCmd adds a default 'completion' command to c. This function will do nothing if any of the following is true: 1- the feature has been explicitly disabled by the program, 2- c has no subcommands (to avoid creating one), 3- c already has a 'completion' command provided by the program.

func (*Command) InitDefaultHelpCmd

func (c *Command) InitDefaultHelpCmd()

InitDefaultHelpCmd adds default help command to c. It is called automatically by executing the c or by calling help and usage. If c already has help command or c has no subcommands, it will do nothing.

func (*Command) InitDefaultHelpFlag

func (c *Command) InitDefaultHelpFlag()

InitDefaultHelpFlag adds default help flag to c. It is called automatically by executing the c or by calling help and usage. If c already has help flag, it will do nothing.

func (*Command) InitDefaultVersionFlag added in v0.0.2

func (c *Command) InitDefaultVersionFlag()

InitDefaultVersionFlag adds default version flag to c. It is called automatically by executing the c. If c already has a version flag, it will do nothing. If c.Version is empty, it will do nothing.

func (*Command) IsAvailableCommand

func (c *Command) IsAvailableCommand() bool

IsAvailableCommand determines if a command is available as a non-help command (this includes all non deprecated/hidden commands).

func (*Command) LocalFlags

LocalFlags returns the local FlagSet specifically set in the current command. This function does not modify the flags of the current command, it's purpose is to return the current state.

func (*Command) LocalNonPersistentFlags

LocalNonPersistentFlags are flags specific to this command which will NOT persist to subcommands. This function does not modify the flags of the current command, it's purpose is to return the current state.

func (*Command) MarkFlagCustom

MarkFlagCustom adds the BashCompCustom annotation to the named flag, if it exists. The bash completion script will call the bash function f for the flag.

This will only work for bash completion. It is recommended to instead use c.RegisterFlagCompletionFunc(...) which allows to register a Go function which will work across all shells.

func (*Command) MarkFlagDirname added in v0.0.5

MarkFlagDirname instructs the various shell completion implementations to limit completions for the named flag to directory names.

func (*Command) MarkFlagFilename

MarkFlagFilename instructs the various shell completion implementations to limit completions for the named flag to the specified file extensions.

func (*Command) MarkFlagRequired

MarkFlagRequired instructs the various shell completion implementations to prioritize the named flag when performing completion, and causes your command to report an error if invoked without the flag.

func (*Command) MarkFlagsMutuallyExclusive added in v1.5.0

func (c *Command) MarkFlagsMutuallyExclusive(flagNames ...string)

MarkFlagsMutuallyExclusive marks the given flags with annotations so that Cobra errors if the command is invoked with more than one flag from the given set of flags.

func (*Command) MarkFlagsOneRequired added in v1.8.0

func (c *Command) MarkFlagsOneRequired(flagNames ...string)

MarkFlagsOneRequired marks the given flags with annotations so that Cobra errors if the command is invoked without at least one flag from the given set of flags.

func (*Command) MarkFlagsRequiredTogether added in v1.5.0

func (c *Command) MarkFlagsRequiredTogether(flagNames ...string)

MarkFlagsRequiredTogether marks the given flags with annotations so that Cobra errors if the command is invoked with a subset (but not all) of the given flags.

func (*Command) MarkPersistentFlagDirname added in v0.0.5

MarkPersistentFlagDirname instructs the various shell completion implementations to limit completions for the named persistent flag to directory names.

func (*Command) MarkPersistentFlagFilename

MarkPersistentFlagFilename instructs the various shell completion implementations to limit completions for the named persistent flag to the specified file extensions.

func (*Command) MarkPersistentFlagRequired

MarkPersistentFlagRequired instructs the various shell completion implementations to prioritize the named persistent flag when performing completion, and causes your command to report an error if invoked without the flag.

func (*Command) MarkZshCompPositionalArgumentFile added in v0.0.5

func (c *Command) MarkZshCompPositionalArgumentFile(argPosition int, patterns ...string) error

MarkZshCompPositionalArgumentFile only worked for zsh and its behavior was not consistent with Bash completion. It has therefore been disabled. Instead, when no other completion is specified, file completion is done by default for every argument. One can disable file completion on a per-argument basis by using ValidArgsFunction and ShellCompDirectiveNoFileComp. To achieve file extension filtering, one can use ValidArgsFunction and ShellCompDirectiveFilterFileExt.

Deprecated

func (*Command) MarkZshCompPositionalArgumentWords added in v0.0.5

func (c *Command) MarkZshCompPositionalArgumentWords(argPosition int, words ...string) error

MarkZshCompPositionalArgumentWords only worked for zsh. It has therefore been disabled. To achieve the same behavior across all shells, one can use ValidArgs (for the first argument only) or ValidArgsFunction for any argument (can include the first one also).

Deprecated

func (*Command) Name

Name returns the command's name: the first word in the use line.

func (*Command) NameAndAliases

func (c *Command) NameAndAliases() string

NameAndAliases returns a list of the command name and all aliases

func (*Command) NamePadding

func (c *Command) NamePadding() int

NamePadding returns padding for the name.

func (*Command) NonInheritedFlags

NonInheritedFlags returns all flags which were not inherited from parent commands. This function does not modify the flags of the current command, it's purpose is to return the current state.

func (*Command) OutOrStderr

OutOrStderr returns output to stderr

func (*Command) OutOrStdout

OutOrStdout returns output to stdout.

func (*Command) Parent

func (c *Command) Parent() *Command

Parent returns a commands parent command.

func (*Command) ParseFlags

ParseFlags parses persistent flag tree and local flags.

func (*Command) PersistentFlags

PersistentFlags returns the persistent FlagSet specifically set in the current command.

func (*Command) Print

func (c *Command) Print(i ...interface{})

Print is a convenience method to Print to the defined output, fallback to Stderr if not set.

func (*Command) PrintErr added in v0.0.5

func (c *Command) PrintErr(i ...interface{})

PrintErr is a convenience method to Print to the defined Err output, fallback to Stderr if not set.

func (*Command) PrintErrf added in v0.0.5

func (c *Command) PrintErrf(format string, i ...interface{})

PrintErrf is a convenience method to Printf to the defined Err output, fallback to Stderr if not set.

func (*Command) PrintErrln added in v0.0.5

func (c *Command) PrintErrln(i ...interface{})

PrintErrln is a convenience method to Println to the defined Err output, fallback to Stderr if not set.

func (*Command) Printf

func (c *Command) Printf(format string, i ...interface{})

Printf is a convenience method to Printf to the defined output, fallback to Stderr if not set.

func (*Command) Println

func (c *Command) Println(i ...interface{})

Println is a convenience method to Println to the defined output, fallback to Stderr if not set.

func (*Command) RegisterFlagCompletionFunc added in v1.0.0

RegisterFlagCompletionFunc should be called to register a function to provide completion for a flag.

You can use pre-defined completion functions such as FixedCompletions or NoFileCompletions, or you can define your own.

func (*Command) RemoveCommand

func (c Command) RemoveCommand(cmds ...Command)

RemoveCommand removes one or more commands from a parent command.

func (*Command) ResetCommands

func (c *Command) ResetCommands()

ResetCommands delete parent, subcommand and help command from c.

func (*Command) ResetFlags

func (c *Command) ResetFlags()

ResetFlags deletes all flags from command.

func (*Command) Root

func (c *Command) Root() *Command

Root finds root command.

func (*Command) Runnable

func (c *Command) Runnable() bool

Runnable determines if the command is itself runnable.

func (*Command) SetArgs

SetArgs sets arguments for the command. It is set to os.Args[1:] by default, if desired, can be overridden particularly useful when testing.

func (*Command) SetCompletionCommandGroupID added in v1.6.0

func (c *Command) SetCompletionCommandGroupID(groupID string)

SetCompletionCommandGroupID sets the group id of the completion command.

func (*Command) SetContext added in v1.5.0

SetContext sets context for the command. This context will be overwritten by Command.ExecuteContext or Command.ExecuteContextC.

func (*Command) SetErr added in v0.0.5

SetErr sets the destination for error messages. If newErr is nil, os.Stderr is used.

func (*Command) SetErrPrefix added in v1.8.0

SetErrPrefix sets error message prefix to be used. Application can use it to set custom prefix.

func (*Command) SetFlagErrorFunc

SetFlagErrorFunc sets a function to generate an error when flag parsing fails.

func (*Command) SetGlobalNormalizationFunc

SetGlobalNormalizationFunc sets a normalization function to all flag sets and also to child commands. The user should not have a cyclic dependency on commands.

func (*Command) SetHelpCommand

func (c *Command) SetHelpCommand(cmd *Command)

SetHelpCommand sets help command.

func (*Command) SetHelpCommandGroupID added in v1.6.0

func (c *Command) SetHelpCommandGroupID(groupID string)

SetHelpCommandGroupID sets the group id of the help command.

func (*Command) SetHelpFunc

func (c Command) SetHelpFunc(f func(Command, []string))

SetHelpFunc sets help function. Can be defined by Application.

func (*Command) SetHelpTemplate

func (c *Command) SetHelpTemplate(s string)

SetHelpTemplate sets help template to be used. Application can use it to set custom template.

func (*Command) SetIn added in v0.0.5

SetIn sets the source for input data If newIn is nil, os.Stdin is used.

func (*Command) SetOut added in v0.0.5

SetOut sets the destination for usage messages. If newOut is nil, os.Stdout is used.

func (*Command) SetOutput deprecated

SetOutput sets the destination for usage and error messages. If output is nil, os.Stderr is used.

Deprecated: Use SetOut and/or SetErr instead

func (*Command) SetUsageFunc

func (c Command) SetUsageFunc(f func(Command) error)

SetUsageFunc sets usage function. Usage can be defined by application.

func (*Command) SetUsageTemplate

func (c *Command) SetUsageTemplate(s string)

SetUsageTemplate sets usage template. Can be defined by Application.

func (*Command) SetVersionTemplate added in v0.0.2

func (c *Command) SetVersionTemplate(s string)

SetVersionTemplate sets version template to be used. Application can use it to set custom template.

func (*Command) SuggestionsFor

SuggestionsFor provides suggestions for the typedName.

func (*Command) Traverse

Traverse the command tree to find the command, and parse args for each parent.

func (*Command) Usage

Usage puts out the usage for the command. Used when a user provides invalid input. Can be defined by user by overriding UsageFunc.

func (*Command) UsageFunc

func (c Command) UsageFunc() (f func(Command) error)

UsageFunc returns either the function set by SetUsageFunc for this command or a parent, or it returns a default usage function.

func (*Command) UsagePadding

func (c *Command) UsagePadding() int

UsagePadding return padding for the usage.

func (*Command) UsageString

UsageString returns usage string.

func (*Command) UsageTemplate

UsageTemplate returns usage template for the command. This function is kept for backwards-compatibility reasons.

func (*Command) UseLine

UseLine puts out the full usage for a given command (including parents).

func (*Command) ValidateFlagGroups added in v1.6.0

func (c *Command) ValidateFlagGroups() error

ValidateFlagGroups validates the mutuallyExclusive/oneRequired/requiredAsGroup logic and returns the first error encountered.

func (*Command) ValidateRequiredFlags added in v1.6.0

func (c *Command) ValidateRequiredFlags() error

ValidateRequiredFlags validates all required flags are present and returns an error otherwise

func (*Command) VersionTemplate added in v0.0.2

func (c *Command) VersionTemplate() string

VersionTemplate return version template for the command. This function is kept for backwards-compatibility reasons.

func (*Command) VisitParents

func (c Command) VisitParents(fn func(Command))

VisitParents visits all parents of the command and invokes fn on each parent.

Completion is a string that can be used for completions

two formats are supported:

CompletionWithDesc can be used to create a completion string with a textual description.

Note: Go type alias is used to provide a more descriptive name in the documentation, but any string can be used.

func AppendActiveHelp(compArray []Completion, activeHelpStr string) []Completion

AppendActiveHelp adds the specified string to the specified array to be used as ActiveHelp. Such strings will be processed by the completion script and will be shown as ActiveHelp to the user. The array parameter should be the array that will contain the completions. This function can be called multiple times before and/or after completions are added to the array. Each time this function is called with the same array, the new ActiveHelp line will be shown below the previous ones when completion is triggered.

CompletionWithDesc returns a Completion with a description by using the TAB delimited format.

CompletionFunc is a function that provides completion results.

func FixedCompletions(choices []Completion, directive ShellCompDirective) CompletionFunc

FixedCompletions can be used to create a completion function which always returns the same results.

This method returns a function that satisfies CompletionFuncIt can be used with Command.RegisterFlagCompletionFunc and for [Command.ValidArgsFunction].

type CompletionOptions struct {

DisableDefaultCmd [bool](/builtin#bool)


DisableNoDescFlag [bool](/builtin#bool)


DisableDescriptions [bool](/builtin#bool)

HiddenDefaultCmd [bool](/builtin#bool)

}

CompletionOptions are the options to control shell completion

FParseErrWhitelist configures Flag parse errors to be ignored

Group Structure to manage groups for commands

func ExactArgs(n int) PositionalArgs

ExactArgs returns an error if there are not exactly n args.

func ExactValidArgs(n int) PositionalArgs

ExactValidArgs returns an error if there are not exactly N positional args OR there are any positional args that are not in the `ValidArgs` field of `Command`

Deprecated: use MatchAll(ExactArgs(n), OnlyValidArgs) instead

func MatchAll(pargs ...PositionalArgs) PositionalArgs

MatchAll allows combining several PositionalArgs to work in concert.

func MaximumNArgs(n int) PositionalArgs

MaximumNArgs returns an error if there are more than N args.

func MinimumNArgs(n int) PositionalArgs

MinimumNArgs returns an error if there is not at least N args.

RangeArgs returns an error if the number of args is not within the expected range.

type ShellCompDirective int

ShellCompDirective is a bit map representing the different behaviors the shell can be instructed to have once completions have been provided.

const (

ShellCompDirectiveError [ShellCompDirective](#ShellCompDirective) = 1 << [iota](/builtin#iota)


ShellCompDirectiveNoSpace


ShellCompDirectiveNoFileComp


ShellCompDirectiveFilterFileExt


ShellCompDirectiveFilterDirs


ShellCompDirectiveKeepOrder


ShellCompDirectiveDefault [ShellCompDirective](#ShellCompDirective) = 0

)

type SliceValue interface {

GetSlice() [][string](/builtin#string)

}

SliceValue is a reduced version of pflag.SliceValue. It is used to detect flags that accept multiple values and therefore can provide completion multiple times.