package cobra

Import Path
	github.com/spf13/cobra (on go.dev)

Dependency Relation
	imports 15 packages, and imported by one package


Involved Source Files

	      args.go
	      bash_completions.go
	      bash_completionsV2.go
	      cobra.go
	
		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.

	      command_notwin.go
	      completions.go
	      fish_completions.go
	      powershell_completions.go
	      shell_completions.go
	      zsh_completions.go


Package-Level Type Names (total 7, in which 5 are exported)


	/* sort exporteds by:  |  */
	
		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.

		
			
				Aliases is an array of aliases that can be used instead of the first word in Use.

			
				Annotations are key/value pairs that can be used by applications to identify or
				group commands.

			
				ArgAliases is List of aliases for ValidArgs.
				These are not suggested to the user in the shell completion,
				but accepted if entered manually.

			
				Expected arguments

			
				BashCompletionFunction is custom bash functions used by the legacy bash autocompletion generator.
				For portability with other shells, it is recommended to instead use ValidArgsFunction

			
				CompletionOptions is a set of options to control the handling of shell completion

			
				Deprecated defines, if this command is deprecated and should print this string when used.

			
				DisableAutoGenTag defines, if gen tag ("Auto generated by spf13/cobra...")
				will be printed by generating docs for this command.

			
				DisableFlagParsing disables the flag parsing.
				If this is true all flags will be passed to the command as arguments.

			
				DisableFlagsInUseLine will disable the addition of [flags] to the usage
				line of a command when printing help or generating docs

			
				DisableSuggestions disables the suggestions based on Levenshtein distance
				that go along with 'unknown command' messages.

			
				Example is examples of how to use the command.

			
				FParseErrWhitelist flag parse errors to be ignored

			
				Hidden defines, if this command is hidden and should NOT show up in the list of available commands.

			
				Long is the long message shown in the 'help <this-command>' output.

			
				PersistentPostRun: children of this command will inherit and execute after PostRun.

			
				PersistentPostRunE: PersistentPostRun but returns an error.

			
				The *Run functions are executed in the following order:
				  * PersistentPreRun()
				  * PreRun()
				  * Run()
				  * PostRun()
				  * PersistentPostRun()
				All functions get the same args, the arguments after the command name.

				PersistentPreRun: children of this command will inherit and execute.

			
				PersistentPreRunE: PersistentPreRun but returns an error.

			
				PostRun: run after the Run command.

			
				PostRunE: PostRun but returns an error.

			
				PreRun: children of this command will not inherit.

			
				PreRunE: PreRun but returns an error.

			
				Run: Typically the actual work function. Most commands will only implement this.

			
				RunE: Run but returns an error.

			
				Short is the short description shown in the 'help' output.

			
				SilenceErrors is an option to quiet errors down stream.

			
				SilenceUsage is an option to silence usage when an error occurs.

			
				SuggestFor is an array of command names for which this command will be suggested -
				similar to aliases but only suggests.

			
				SuggestionsMinimumDistance defines minimum levenshtein distance to display suggestions.
				Must be > 0.

			
				TraverseChildren parses flags on all parents before executing child command.

			
				Use is the one-line usage message.
				Recommended syntax is as follow:
				  [ ] identifies an optional argument. Arguments that are not enclosed in brackets are required.
				  ... indicates that you can specify multiple values for the previous argument.
				  |   indicates mutually exclusive information. You can use the argument to the left of the separator or the
				      argument to the right of the separator. You cannot use both arguments in a single use of the command.
				  { } delimits a set of mutually exclusive arguments when one of the arguments is required. If the arguments are
				      optional, they are enclosed in brackets ([ ]).
				Example: add [-F file | -D dir]... [-f format] profile

			
				ValidArgs is list of all valid non-flag arguments that are accepted in shell completions

			
				ValidArgsFunction is an optional function that provides valid non-flag arguments for shell completion.
				It is a dynamic version of using ValidArgs.
				Only one of ValidArgs and ValidArgsFunction can be used for a command.

			
				Version defines the version for this command. If this value is non-empty and the command does not
				define a "version" flag, a "version" boolean flag will be added to the command and, if specified,
				will print content of the "Version" variable. A shorthand "v" flag will also be added if the
				command does not define one.

			
		
			
				AddCommand adds one or more commands to this parent command.

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

			
				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.

			
				CommandPath returns the full path to this command.

			
				CommandPathPadding return padding for the command path.

			
				Commands returns a sorted slice of child commands.

			
				Context returns underlying command context. If command wasn't
				executed with ExecuteContext Context returns Background context.

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

			
				ErrOrStderr returns output to stderr

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

			
				ExecuteC executes the command.

			
				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.

			
				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.

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

			
				Flag climbs up the command tree looking for matching flag.

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

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

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

			
				GenBashCompletionFile generates bash completion file.

			
				GenBashCompletionFileV2 generates Bash completion version 2.

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

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

			
				GenFishCompletionFile generates fish completion file.

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

			
				GenPowerShellCompletionFile generates powershell completion file without descriptions.

			
				GenPowerShellCompletionFileWithDesc generates powershell completion file with descriptions.

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

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

			
				GenZshCompletionFile generates zsh completion file including descriptions.

			
				GenZshCompletionFileNoDesc generates zsh completion file without descriptions.

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

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

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

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

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

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

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

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

			
				HasExample determines if the command has example.

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

			
				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'.

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

			
				HasLocalFlags checks if the command has flags specifically declared locally.

			
				HasParent determines if the command is a child command.

			
				HasPersistentFlags checks if the command contains persistent flags.

			
				HasSubCommands determines if the command has children commands.

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

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

			
				HelpTemplate return help template for the command.

			
				InOrStdin returns input to stdin

			
				InheritedFlags returns all flags which were inherited from parent commands.

			
				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.

			
				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.

			
				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.

			
				IsAdditionalHelpTopicCommand determines if a command is an additional
				help topic command; additional help topic command is determined by the
				fact that it is NOT runnable/hidden/deprecated, and has no sub commands that
				are runnable/hidden/deprecated.
				Concrete example: https://github.com/spf13/cobra/issues/393#issuecomment-282741924.

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

			
				LocalFlags returns the local FlagSet specifically set in the current command.

			
				LocalNonPersistentFlags are flags specific to this command which will NOT persist to subcommands.

			
				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.

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

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

			
				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.

			
				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

			
				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

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

			
				NameAndAliases returns a list of the command name and all aliases

			
				NamePadding returns padding for the name.

			
				NonInheritedFlags returns all flags which were not inherited from parent commands.

			
				OutOrStderr returns output to stderr

			
				OutOrStdout returns output to stdout.

			
				Parent returns a commands parent command.

			
				ParseFlags parses persistent flag tree and local flags.

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

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

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

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

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

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

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

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

			
				RemoveCommand removes one or more commands from a parent command.

			
				ResetCommands delete parent, subcommand and help command from c.

			
				ResetFlags deletes all flags from command.

			
				Root finds root command.

			
				Runnable determines if the command is itself runnable.

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

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

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

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

			
				SetHelpCommand sets help command.

			
				SetHelpFunc sets help function. Can be defined by Application.

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

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

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

			
				SetOutput sets the destination for usage and error messages.
				If output is nil, os.Stderr is used.
				Deprecated: Use SetOut and/or SetErr instead

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

			
				SetUsageTemplate sets usage template. Can be defined by Application.

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

			
				SuggestionsFor provides suggestions for the typedName.

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

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

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

			
				UsagePadding return padding for the usage.

			
				UsageString returns usage string.

			
				UsageTemplate returns usage template for the command.

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

			(*T) ValidateArgs(args []string) error
			
				VersionTemplate return version template for the command.

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

			
		
			func (*Command).Commands() []*Command
			func (*Command).ExecuteC() (cmd *Command, err error)
			func (*Command).ExecuteContextC(ctx context.Context) (*Command, error)
			func (*Command).Find(args []string) (*Command, []string, error)
			func (*Command).Parent() *Command
			func (*Command).Root() *Command
			func (*Command).Traverse(args []string) (*Command, []string, error)
			
		
			func ArbitraryArgs(cmd *Command, args []string) error
			func NoArgs(cmd *Command, args []string) error
			func NoFileCompletions(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)
			func OnlyValidArgs(cmd *Command, args []string) error
			func (*Command).AddCommand(cmds ...*Command)
			func (*Command).RemoveCommand(cmds ...*Command)
			func (*Command).SetHelpCommand(cmd *Command)
			
		
			


	
		CompletionOptions are the options to control shell completion

		
			
				DisableDefaultCmd prevents Cobra from creating a default 'completion' command

			
				DisableDescriptions turns off all completion descriptions for shells
				that support them

			
				DisableNoDescFlag prevents Cobra from creating the '--no-descriptions' flag
				for shells that support completion descriptions



	
		FParseErrWhitelist configures Flag parse errors to be ignored

		
			
				UnknownFlags will ignore unknown flags errors and continue parsing rest of the flags



	

		
			func ExactArgs(n int) PositionalArgs
			func ExactValidArgs(n int) PositionalArgs
			func MaximumNArgs(n int) PositionalArgs
			func MinimumNArgs(n int) PositionalArgs
			func RangeArgs(min int, max int) PositionalArgs


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

		
			
		
			func NoFileCompletions(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)
			
		
			const ShellCompDirectiveDefault
			const ShellCompDirectiveError
			const ShellCompDirectiveFilterDirs
			const ShellCompDirectiveFilterFileExt
			const ShellCompDirectiveNoFileComp
			const ShellCompDirectiveNoSpace
			


	


Package-Level Functions (total 59, in which 24 are exported)


	
		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.


	
		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.


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


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


	
		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`


	
		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.


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


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


	
		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.


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


	
		OnlyValidArgs returns an error if any args are not in the list of ValidArgs.


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


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


	


Package-Level Variables (total 12, in which 4 are exported)


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


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


	
		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.


	
		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.


	


Package-Level Constants (total 18, in which 12 are exported)


	
		Annotations for Bash completion.


	
		Annotations for Bash completion.


	
		Annotations for Bash completion.


	
		Annotations for Bash completion.


	
		ShellCompDirectiveDefault indicates to let the shell perform its default
		behavior after completions have been provided.
		This one must be last to avoid messing up the iota count.


	
		ShellCompDirectiveError indicates an error occurred and completions should be ignored.


	
		ShellCompDirectiveFilterDirs indicates that only directory names should
		be provided in file completion.  To request directory names within another
		directory, the returned completions should specify the directory within
		which to search.  The BashCompSubdirsInDir annotation can be used to
		obtain the same behavior but only for flags.


	
		ShellCompDirectiveFilterFileExt indicates that the provided completions
		should be used as file extension filters.
		For flags, using Command.MarkFlagFilename() and Command.MarkPersistentFlagFilename()
		is a shortcut to using this directive explicitly.  The BashCompFilenameExt
		annotation can also be used to obtain the same behavior for flags.


	
		ShellCompDirectiveNoFileComp indicates that the shell should not provide
		file completion even when no completion is provided.


	
		ShellCompDirectiveNoSpace indicates that the shell should not add a space
		after the completion even if there is a single completion provided.


	
		ShellCompNoDescRequestCmd is the name of the hidden command that is used to request
		completion results without their description.  It is used by the shell completion scripts.


	
		ShellCompRequestCmd is the name of the hidden command that is used to request
		completion results from the program.  It is used by the shell completion scripts.