static/jsvm/classes/Command.html
Command defines a single console command.
Example:
const command = new Command({ use: "hello", run: (cmd, args) => { console.log("Hello world!") },})$app.rootCmd.addCommand(command);Copy
addCommandaddGroupallChildCommandsHaveGroupargsLenAtDashcalledAscommandPathcommandPathPaddingcommandscontainsGroupcontextdebugFlagsdisplayNameerrOrStderrerrPrefixexecuteexecuteCexecuteContextexecuteContextCfindflagflagErrorFuncflagsgenBashCompletiongenBashCompletionFilegenBashCompletionFileV2genBashCompletionV2genFishCompletiongenFishCompletionFilegenPowerShellCompletiongenPowerShellCompletionFilegenPowerShellCompletionFileWithDescgenPowerShellCompletionWithDescgenZshCompletiongenZshCompletionFilegenZshCompletionFileNoDescgenZshCompletionNoDescgetFlagCompletionFuncglobalNormalizationFuncgroupshasAliashasAvailableFlagshasAvailableInheritedFlagshasAvailableLocalFlagshasAvailablePersistentFlagshasAvailableSubCommandshasExamplehasFlagshasHelpSubCommandshasInheritedFlagshasLocalFlagshasParenthasPersistentFlagshasSubCommandshelphelpFunchelpTemplateinOrStdininheritedFlagsinitDefaultCompletionCmdinitDefaultHelpCmdinitDefaultHelpFlaginitDefaultVersionFlagisAdditionalHelpTopicCommandisAvailableCommandlocalFlagslocalNonPersistentFlagsmarkFlagCustommarkFlagDirnamemarkFlagFilenamemarkFlagRequiredmarkFlagsMutuallyExclusivemarkFlagsOneRequiredmarkFlagsRequiredTogethermarkPersistentFlagDirnamemarkPersistentFlagFilenamemarkPersistentFlagRequiredmarkZshCompPositionalArgumentFilemarkZshCompPositionalArgumentWordsnamenameAndAliasesnamePaddingnonInheritedFlagsoutOrStderroutOrStdoutparentparseFlagspersistentFlagsprintprintErrprintErrfprintErrlnprintfprintlnregisterFlagCompletionFuncremoveCommandresetCommandsresetFlagsrootrunnablesetArgssetCompletionCommandGroupIDsetContextsetErrsetErrPrefixsetFlagErrorFuncsetGlobalNormalizationFuncsetHelpCommandsetHelpCommandGroupIDsetHelpFuncsetHelpTemplatesetInsetOutsetOutputsetUsageFuncsetUsageTemplatesetVersionTemplatesuggestionsFortraverseusageusageFuncusagePaddingusageStringusageTemplateuseLinevalidateArgsvalidateFlagGroupsvalidateRequiredFlagsversionTemplatevisitParents
aliasesannotationsargAliasesargsbashCompletionFunctioncompletionOptionsdeprecateddisableAutoGenTagdisableFlagParsingdisableFlagsInUseLinedisableSuggestionsexamplefParseErrWhitelistgroupIDhiddenlongpersistentPostRunpersistentPostRunEpersistentPreRunpersistentPreRunEpostRunpostRunEpreRunpreRunErunrunEshortsilenceErrorssilenceUsagesuggestForsuggestionsMinimumDistancetraverseChildrenusevalidArgsvalidArgsFunctionversion
Optional cmd: Partial<cobra.Command>AddCommand adds one or more commands to this parent command.
Rest ...cmds: cobra.Command[]AddGroup adds one or more command groups to this parent command.
Rest ...groups: Group[]AllChildCommandsHaveGroup returns if all subcommands are assigned to a group
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.
ContainsGroup return if groupID exists in the list of command groups.
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.
DebugFlags used to determine which flags have been assigned to which commands and which persist.
DisplayName returns the name to display in help text. Returns command Name() If CommandDisplayNameAnnoation is not set
ErrOrStderr returns output to stderr
ErrPrefix return error message prefix for the command
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.
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.
GetFlagCompletionFunc returns the completion function for the given flag of the command, if available.
GlobalNormalizationFunc returns the global normalization function or nil if it doesn't exist.
GlobalNormalizationFunc returns the global normalization function or nil if it doesn't exist.
-
-
Groups returns a slice of child command groups.
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.
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. This function is kept for backwards-compatibility reasons.
InOrStdin returns input to stdin
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.
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.
Rest ...args: string[]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. This function does not modify the flags of the current command, it's purpose is to return the current state.
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.
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.
Rest ...extensions: string[]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.
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.
Rest ...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.
Rest ...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.
Rest ...flagNames: string[]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.
Rest ...extensions: string[]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
Rest ...patterns: string[]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
Rest ...words: string[]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. This function does not modify the flags of the current command, it's purpose is to return the current state.
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.
Rest ...i: {}[]PrintErr is a convenience method to Print to the defined Err output, fallback to Stderr if not set.
Rest ...i: {}[]PrintErrf is a convenience method to Printf to the defined Err output, fallback to Stderr if not set.
Rest ...i: {}[]PrintErrln is a convenience method to Println to the defined Err output, fallback to Stderr if not set.
Rest ...i: {}[]Printf is a convenience method to Printf to the defined output, fallback to Stderr if not set.
Rest ...i: {}[]Println is a convenience method to Println to the defined output, fallback to Stderr if not set.
Rest ...i: {}[]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.
RemoveCommand removes one or more commands from a parent command.
Rest ...cmds: cobra.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.
SetCompletionCommandGroupID sets the group id of the completion command.
SetContext sets context for the command. This context will be overwritten by Command.ExecuteContext or Command.ExecuteContextC.
SetErr sets the destination for error messages. If newErr is nil, os.Stderr is used.
SetErrPrefix sets error message prefix to be used. Application can use it to set custom prefix.
SetFlagErrorFunc sets a function to generate an error when flag parsing fails.
-
- (\_arg0, \_arg1): void
-
-
-
SetGlobalNormalizationFunc sets a normalization function to all flag sets and also to child commands. The user should not have a cyclic dependency on commands.
-
- (f, name): any
-
-
-
SetHelpCommand sets help command.
SetHelpCommandGroupID sets the group id of the help command.
SetHelpFunc sets help function. Can be defined by Application.
-
- (\_arg0, \_arg1): void
-
-
-
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.
-
- (\_arg0): void
-
-
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.
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. This function is kept for backwards-compatibility reasons.
UseLine puts out the full usage for a given command (including parents).
ValidateFlagGroups validates the mutuallyExclusive/oneRequired/requiredAsGroup logic and returns the first error encountered.
ValidateRequiredFlags validates all required flags are present and returns an error otherwise
VersionTemplate return version template for the command. This function is kept for backwards-compatibility reasons.
VisitParents visits all parents of the command and invokes fn on each parent.
-
- (\_arg0): void
-
-
aliases: string[]
Aliases is an array of aliases that can be used instead of the first word in Use.
annotations: _TygojaDict
Annotations are key/value pairs that can be used by applications to identify or group commands or set special options.
argAliases: string[]
ArgAliases is List of aliases for ValidArgs. These are not suggested to the user in the shell completion, but accepted if entered manually.
args: PositionalArgs
Expected arguments
bashCompletionFunction: string
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: CompletionOptions
CompletionOptions is a set of options to control the handling of shell completion
deprecated: string
Deprecated defines, if this command is deprecated and should print this string when used.
disableAutoGenTag: boolean
DisableAutoGenTag defines, if gen tag ("Auto generated by spf13/cobra...") will be printed by generating docs for this command.
disableFlagParsing: boolean
DisableFlagParsing disables the flag parsing. If this is true all flags will be passed to the command as arguments.
disableFlagsInUseLine: boolean
DisableFlagsInUseLine will disable the addition of [flags] to the usage line of a command when printing help or generating docs
disableSuggestions: boolean
DisableSuggestions disables the suggestions based on Levenshtein distance that go along with 'unknown command' messages.
example: string
Example is examples of how to use the command.
fParseErrWhitelist: FParseErrWhitelist
FParseErrWhitelist flag parse errors to be ignored
groupID: string
The group id under which this subcommand is grouped in the 'help' output of its parent.
hidden: boolean
Hidden defines, if this command is hidden and should NOT show up in the list of available commands.
long: string
Long is the long message shown in the 'help ' output.
persistentPostRun: ((cmd, args) => void)
PersistentPostRun: children of this command will inherit and execute after PostRun.
-
-
persistentPostRunE: ((cmd, args) => void)
PersistentPostRunE: PersistentPostRun but returns an error.
-
-
persistentPreRun: ((cmd, args) => void)
The *Run functions are executed in the following order:
* PersistentPreRun() * PreRun() * Run() * PostRun() * PersistentPostRun()Copy
All functions get the same args, the arguments after the command name. The *PreRun and *PostRun functions will only be executed if the Run function of the current command has been declared.
PersistentPreRun: children of this command will inherit and execute.
-
-
persistentPreRunE: ((cmd, args) => void)
PersistentPreRunE: PersistentPreRun but returns an error.
-
-
postRun: ((cmd, args) => void)
PostRun: run after the Run command.
-
-
postRunE: ((cmd, args) => void)
PostRunE: PostRun but returns an error.
-
-
preRun: ((cmd, args) => void)
PreRun: children of this command will not inherit.
-
-
preRunE: ((cmd, args) => void)
PreRunE: PreRun but returns an error.
-
-
run: ((cmd, args) => void)
Run: Typically the actual work function. Most commands will only implement this.
-
-
runE: ((cmd, args) => void)
RunE: Run but returns an error.
-
-
short: string
Short is the short description shown in the 'help' output.
silenceErrors: boolean
SilenceErrors is an option to quiet errors down stream.
silenceUsage: boolean
SilenceUsage is an option to silence usage when an error occurs.
suggestFor: string[]
SuggestFor is an array of command names for which this command will be suggested - similar to aliases but only suggests.
suggestionsMinimumDistance: number
SuggestionsMinimumDistance defines minimum levenshtein distance to display suggestions. Must be > 0.
traverseChildren: boolean
TraverseChildren parses flags on all parents before executing child command.
use: string
Use is the one-line usage message. Recommended syntax is as follows:
[] 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 ([]).Copy
Example: add [-F file | -D dir]... [-f format] profile
validArgs: Completion[]
ValidArgs is list of all valid non-flag arguments that are accepted in shell completions
validArgsFunction: CompletionFunc
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: string
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.
OSLightDark
Generated using TypeDoc