Documentation ¶
Overview ¶
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.
Index ¶
- Constants
- Variables
- func AddTemplateFunc(name string, tmplFunc interface{})
- func AddTemplateFuncs(tmplFuncs template.FuncMap)
- func Eq(a interface{}, b interface{}) bool
- func Gt(a interface{}, b interface{}) bool
- func MarkFlagFilename(flags *pflag.FlagSet, name string, extensions ...string) error
- func MarkFlagRequired(flags *pflag.FlagSet, name string) error
- func OnInitialize(y ...func())
- type Command
- func (c *Command) AddCommand(cmds ...*Command)
- func (c *Command) ArgsLenAtDash() int
- func (c *Command) CommandPath() string
- func (c *Command) CommandPathPadding() int
- func (c *Command) Commands() []*Command
- func (c *Command) DebugFlags()
- func (c *Command) Execute() error
- func (c *Command) ExecuteC() (cmd *Command, err error)
- func (c *Command) Find(args []string) (*Command, []string, error)
- func (c *Command) Flag(name string) (flag *flag.Flag)
- func (c *Command) Flags() *flag.FlagSet
- func (cmd *Command) GenBashCompletion(w io.Writer) error
- func (cmd *Command) GenBashCompletionFile(filename string) error
- func (c *Command) GlobalNormalizationFunc() func(f *flag.FlagSet, name string) flag.NormalizedName
- func (c *Command) HasAlias(s string) bool
- func (c *Command) HasAvailableSubCommands() bool
- func (c *Command) HasExample() bool
- func (c *Command) HasFlags() bool
- func (c *Command) HasHelpSubCommands() bool
- func (c *Command) HasInheritedFlags() bool
- func (c *Command) HasLocalFlags() bool
- func (c *Command) HasParent() bool
- func (c *Command) HasPersistentFlags() bool
- func (c *Command) HasSubCommands() bool
- func (c *Command) Help() error
- func (c *Command) HelpFunc() func(*Command, []string)
- func (c *Command) HelpTemplate() string
- func (c *Command) InheritedFlags() *flag.FlagSet
- func (c *Command) IsAvailableCommand() bool
- func (c *Command) IsHelpCommand() bool
- func (c *Command) LocalFlags() *flag.FlagSet
- func (cmd *Command) MarkFlagFilename(name string, extensions ...string) error
- func (cmd *Command) MarkFlagRequired(name string) error
- func (cmd *Command) MarkPersistentFlagFilename(name string, extensions ...string) error
- func (cmd *Command) MarkPersistentFlagRequired(name string) error
- func (c *Command) Name() string
- func (c *Command) NameAndAliases() string
- func (c *Command) NamePadding() int
- func (c *Command) NonInheritedFlags() *flag.FlagSet
- func (c *Command) Out() io.Writer
- func (c *Command) Parent() *Command
- func (c *Command) ParseFlags(args []string) (err error)
- func (c *Command) PersistentFlags() *flag.FlagSet
- func (c *Command) Print(i ...interface{})
- func (c *Command) Printf(format string, i ...interface{})
- func (c *Command) Println(i ...interface{})
- func (c *Command) RemoveCommand(cmds ...*Command)
- func (c *Command) ResetCommands()
- func (c *Command) ResetFlags()
- func (c *Command) Root() *Command
- func (c *Command) Runnable() bool
- func (c *Command) SetArgs(a []string)
- func (c *Command) SetGlobalNormalizationFunc(n func(f *flag.FlagSet, name string) flag.NormalizedName)
- func (c *Command) SetHelpCommand(cmd *Command)
- func (c *Command) SetHelpFunc(f func(*Command, []string))
- func (c *Command) SetHelpTemplate(s string)
- func (c *Command) SetOutput(output io.Writer)
- func (c *Command) SetUsageFunc(f func(*Command) error)
- func (c *Command) SetUsageTemplate(s string)
- func (c *Command) SuggestionsFor(typedName string) []string
- func (c *Command) Usage() error
- func (c *Command) UsageFunc() (f func(*Command) error)
- func (c *Command) UsagePadding() int
- func (c *Command) UsageString() string
- func (c *Command) UsageTemplate() string
- func (c *Command) UseLine() string
- func (c *Command) VisitParents(fn func(*Command))
Constants ¶
const ( BashCompFilenameExt = "cobra_annotation_bash_completion_filename_extentions" BashCompOneRequiredFlag = "cobra_annotation_bash_completion_one_required_flag" BashCompSubdirsInDir = "cobra_annotation_bash_completion_subdirs_in_dir" )
Variables ¶
var EnablePrefixMatching bool = false
automatic prefix matching can be a dangerous thing to automatically enable in CLI tools. Set this to true to enable it
Functions ¶
func AddTemplateFunc ¶
func AddTemplateFunc(name string, tmplFunc interface{})
AddTemplateFunc adds a template function that's available to Usage and Help template generation.
func AddTemplateFuncs ¶
AddTemplateFuncs adds multiple template functions availalble to Usage and Help template generation.
func Eq ¶
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 Gt ¶
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.
func MarkFlagFilename ¶
MarkFlagFilename adds the BashCompFilenameExt annotation to the named flag in the flag set, if it exists. Generated bash autocompletion will select filenames for the flag, limiting to named extensions if provided.
func MarkFlagRequired ¶
MarkFlagRequired adds the BashCompOneRequiredFlag annotation to the named flag in the flag set, if it exists.
func OnInitialize ¶
func OnInitialize(y ...func())
OnInitialize takes a series of func() arguments and appends them to a slice of func().
Types ¶
type Command ¶
type Command struct { // The one-line usage message. Use string // An array of aliases that can be used instead of the first word in Use. Aliases []string // An array of command names for which this command will be suggested - similar to aliases but only suggests. SuggestFor []string // The short description shown in the 'help' output. Short string // The long message shown in the 'help <this-command>' output. Long string // Examples of how to use the command Example string // List of all valid non-flag arguments, used for bash completions *TODO* actually validate these ValidArgs []string // Custom functions used by the bash autocompletion generator BashCompletionFunction string // Is this command deprecated and should print this string when used? Deprecated string // Is this command hidden and should NOT show up in the list of available commands? Hidden bool // SilenceErrors is an option to quiet errors down stream SilenceErrors bool // Silence Usage is an option to silence usage when an error occurs. SilenceUsage bool // 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 PersistentPreRun func(cmd *Command, args []string) // PersistentPreRunE: PersistentPreRun but returns an error PersistentPreRunE func(cmd *Command, args []string) error // PreRun: children of this command will not inherit. PreRun func(cmd *Command, args []string) // PreRunE: PreRun but returns an error PreRunE func(cmd *Command, args []string) error // Run: Typically the actual work function. Most commands will only implement this Run func(cmd *Command, args []string) // RunE: Run but returns an error RunE func(cmd *Command, args []string) error // PostRun: run after the Run command. PostRun func(cmd *Command, args []string) // PostRunE: PostRun but returns an error PostRunE func(cmd *Command, args []string) error // PersistentPostRun: children of this command will inherit and execute after PostRun PersistentPostRun func(cmd *Command, args []string) // PersistentPostRunE: PersistentPostRun but returns an error PersistentPostRunE func(cmd *Command, args []string) error // DisableAutoGenTag remove DisableAutoGenTag bool // Disable the suggestions based on Levenshtein distance that go along with 'unknown command' messages DisableSuggestions bool // If displaying suggestions, allows to set the minimum levenshtein distance to display, must be > 0 SuggestionsMinimumDistance int // contains filtered or unexported fields }
Command is just that, a command for your application. eg. '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 ¶
AddCommand adds one or more commands to this parent command.
func (*Command) ArgsLenAtDash ¶
ArgsLenAtDash will return the length of f.Args at the moment when a -- was found during arg parsing. This allows your program to know which args were before the -- and which came after. (Description from https://godoc.org/github.com/spf13/pflag#FlagSet.ArgsLenAtDash).
func (*Command) CommandPath ¶
CommandPath returns the full path to this command.
func (*Command) CommandPathPadding ¶
func (*Command) DebugFlags ¶
func (c *Command) DebugFlags()
For use in determining which flags have been assigned to which commands and which persist
func (*Command) Execute ¶
Call execute to use the args (os.Args[1:] by default) and run through the command tree finding appropriate matches for commands and then corresponding flags.
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) Flags ¶
Get the complete FlagSet that applies to this command (local and persistent declared here and by all parents)
func (*Command) GenBashCompletionFile ¶
func (*Command) GlobalNormalizationFunc ¶
GlobalNormalizationFunc returns the global normalization function or nil if doesn't exists
func (*Command) HasAvailableSubCommands ¶
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 (*Command) HasFlags ¶
Does the command contain any flags (local plus persistent from the entire structure)
func (*Command) HasHelpSubCommands ¶
HasHelpSubCommands determines if a command has any avilable 'help' sub commands that need to be shown in the usage/help default template under 'additional help topics'
func (*Command) HasInheritedFlags ¶
func (*Command) HasLocalFlags ¶
Does the command has flags specifically declared locally
func (*Command) HasPersistentFlags ¶
Does the command contain persistent flags
func (*Command) HasSubCommands ¶
Determine if the command has children commands
func (*Command) Help ¶
Output the help for the command Used when a user calls help [command] by the default HelpFunc in the commander
func (*Command) HelpFunc ¶
HelpFunc returns either the function set by SetHelpFunc for this command or a parent, or it returns a function which calls c.Help()
func (*Command) HelpTemplate ¶
func (*Command) InheritedFlags ¶
All Flags which were inherited from parents commands
func (*Command) IsAvailableCommand ¶
IsAvailableCommand determines if a command is available as a non-help command (this includes all non deprecated/hidden commands)
func (*Command) IsHelpCommand ¶
IsHelpCommand determines if a command is a 'help' command; a help command is determined by the fact that it is NOT runnable/hidden/deprecated, and has no sub commands that are runnable/hidden/deprecated
func (*Command) LocalFlags ¶
Get the local FlagSet specifically set in the current command
func (*Command) MarkFlagFilename ¶
MarkFlagFilename adds the BashCompFilenameExt annotation to the named flag, if it exists. Generated bash autocompletion will select filenames for the flag, limiting to named extensions if provided.
func (*Command) MarkFlagRequired ¶
MarkFlagRequired adds the BashCompOneRequiredFlag annotation to the named flag, if it exists.
func (*Command) MarkPersistentFlagFilename ¶
MarkPersistentFlagFilename adds the BashCompFilenameExt annotation to the named persistent flag, if it exists. Generated bash autocompletion will select filenames for the flag, limiting to named extensions if provided.
func (*Command) MarkPersistentFlagRequired ¶
MarkPersistentFlagRequired adds the BashCompOneRequiredFlag annotation to the named persistent flag, if it exists.
func (*Command) NameAndAliases ¶
func (*Command) NamePadding ¶
func (*Command) NonInheritedFlags ¶
All Flags which were not inherited from parent commands
func (*Command) ParseFlags ¶
Parses persistent flag tree & local flags
func (*Command) PersistentFlags ¶
Get the Persistent FlagSet specifically set in the current command
func (*Command) Print ¶
func (c *Command) Print(i ...interface{})
Convenience method to Print to the defined output
func (*Command) Println ¶
func (c *Command) Println(i ...interface{})
Convenience method to Println to the defined output
func (*Command) RemoveCommand ¶
AddCommand removes one or more commands from a parent command.
func (*Command) SetArgs ¶
os.Args[1:] by default, if desired, can be overridden particularly useful when testing.
func (*Command) SetGlobalNormalizationFunc ¶
func (c *Command) SetGlobalNormalizationFunc(n func(f *flag.FlagSet, name string) flag.NormalizedName)
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 (*Command) SetHelpFunc ¶
Can be defined by Application
func (*Command) SetHelpTemplate ¶
Can be defined by Application
func (*Command) SetOutput ¶
SetOutput sets the destination for usage and error messages. If output is nil, os.Stderr is used.
func (*Command) SetUsageFunc ¶
Usage can be defined by application
func (*Command) SetUsageTemplate ¶
Can be defined by Application
func (*Command) SuggestionsFor ¶
func (*Command) Usage ¶
Output the usage for the command Used when a user provides invalid input Can be defined by user by overriding UsageFunc