cobra: github.com/spf13/cobra Index | Files | Directories

package cobra

import "github.com/spf13/cobra"

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

Package Files

args.go bash_completions.go cobra.go command.go command_notwin.go zsh_completions.go

Constants

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.

Variables

var EnableCommandSorting = true

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

var EnablePrefixMatching = 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.

var MousetrapHelpText string = `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 Uses

func AddTemplateFunc(name string, tmplFunc interface{})

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

func AddTemplateFuncs Uses

func AddTemplateFuncs(tmplFuncs template.FuncMap)

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

func ArbitraryArgs Uses

func ArbitraryArgs(cmd *Command, args []string) error

ArbitraryArgs never returns an error.

func Eq Uses

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 Uses

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 MarkFlagCustom Uses

func MarkFlagCustom(flags *pflag.FlagSet, name string, f string) error

MarkFlagCustom adds the BashCompCustom annotation to the named flag in the flag set, if it exists. Generated bash autocompletion will call the bash function f for the flag.

func MarkFlagFilename Uses

func MarkFlagFilename(flags *pflag.FlagSet, name string, extensions ...string) error

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 Uses

func MarkFlagRequired(flags *pflag.FlagSet, name string) error

MarkFlagRequired adds the BashCompOneRequiredFlag annotation to the named flag in the flag set, if it exists.

func NoArgs Uses

func NoArgs(cmd *Command, args []string) error

NoArgs returns an error if any args are included.

func OnInitialize Uses

func OnInitialize(y ...func())

OnInitialize takes a series of func() arguments and appends them to a slice of func().

func OnlyValidArgs Uses

func OnlyValidArgs(cmd *Command, args []string) error

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

type Command Uses

type Command struct {
    // Use is the one-line usage message.
    Use string

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

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

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

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

    // Example is examples of how to use the command.
    Example string

    // ValidArgs is list of all valid non-flag arguments that are accepted in bash completions
    ValidArgs []string

    // Expected arguments
    Args PositionalArgs

    // ArgAliases is List of aliases for ValidArgs.
    // These are not suggested to the user in the bash completion,
    // but accepted if entered manually.
    ArgAliases []string

    // BashCompletionFunction is custom functions used by the bash autocompletion generator.
    BashCompletionFunction string

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

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

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

    // 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

    // SilenceErrors is an option to quiet errors down stream.
    SilenceErrors bool

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

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

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

    // DisableSuggestions disables the suggestions based on Levenshtein distance
    // that go along with 'unknown command' messages.
    DisableSuggestions bool
    // SuggestionsMinimumDistance defines minimum levenshtein distance to display suggestions.
    // Must be > 0.
    SuggestionsMinimumDistance int

    // TraverseChildren parses flags on all parents before executing child command.
    TraverseChildren bool
    // contains filtered or unexported fields
}

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 Uses

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

AddCommand adds one or more commands to this parent command.

func (*Command) ArgsLenAtDash Uses

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) CommandPath Uses

func (c *Command) CommandPath() string

CommandPath returns the full path to this command.

func (*Command) CommandPathPadding Uses

func (c *Command) CommandPathPadding() int

CommandPathPadding return padding for the command path.

func (*Command) Commands Uses

func (c *Command) Commands() []*Command

Commands returns a sorted slice of child commands.

func (*Command) DebugFlags Uses

func (c *Command) DebugFlags()

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

func (*Command) Execute Uses

func (c *Command) Execute() error

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 Uses

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

ExecuteC executes the command.

func (*Command) Find Uses

func (c *Command) Find(args []string) (*Command, []string, error)

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

func (*Command) Flag Uses

func (c *Command) Flag(name string) (flag *flag.Flag)

Flag climbs up the command tree looking for matching flag.

func (*Command) FlagErrorFunc Uses

func (c *Command) FlagErrorFunc() (f func(*Command, error) 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.

func (*Command) Flags Uses

func (c *Command) Flags() *flag.FlagSet

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

func (*Command) GenBashCompletion Uses

func (c *Command) GenBashCompletion(w io.Writer) error

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

func (*Command) GenBashCompletionFile Uses

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

GenBashCompletionFile generates bash completion file.

func (*Command) GenZshCompletion Uses

func (c *Command) GenZshCompletion(w io.Writer) error

GenZshCompletion generates a zsh completion file and writes to the passed writer.

func (*Command) GenZshCompletionFile Uses

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

GenZshCompletionFile generates zsh completion file.

func (*Command) GlobalNormalizationFunc Uses

func (c *Command) GlobalNormalizationFunc() func(f *flag.FlagSet, name string) flag.NormalizedName

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

func (*Command) HasAlias Uses

func (c *Command) HasAlias(s string) bool

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

func (*Command) HasAvailableFlags Uses

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 Uses

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 Uses

func (c *Command) HasAvailableLocalFlags() bool

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

func (*Command) HasAvailablePersistentFlags Uses

func (c *Command) HasAvailablePersistentFlags() bool

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

func (*Command) HasAvailableSubCommands Uses

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 Uses

func (c *Command) HasExample() bool

HasExample determines if the command has example.

func (*Command) HasFlags Uses

func (c *Command) HasFlags() bool

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

func (*Command) HasHelpSubCommands Uses

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 Uses

func (c *Command) HasInheritedFlags() bool

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

func (*Command) HasLocalFlags Uses

func (c *Command) HasLocalFlags() bool

HasLocalFlags checks if the command has flags specifically declared locally.

func (*Command) HasParent Uses

func (c *Command) HasParent() bool

HasParent determines if the command is a child command.

func (*Command) HasPersistentFlags Uses

func (c *Command) HasPersistentFlags() bool

HasPersistentFlags checks if the command contains persistent flags.

func (*Command) HasSubCommands Uses

func (c *Command) HasSubCommands() bool

HasSubCommands determines if the command has children commands.

func (*Command) Help Uses

func (c *Command) Help() error

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 Uses

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 Uses

func (c *Command) HelpTemplate() string

HelpTemplate return help template for the command.

func (*Command) InheritedFlags Uses

func (c *Command) InheritedFlags() *flag.FlagSet

InheritedFlags returns all flags which were inherited from parents commands.

func (*Command) InitDefaultHelpCmd Uses

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 Uses

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) IsAdditionalHelpTopicCommand Uses

func (c *Command) IsAdditionalHelpTopicCommand() bool

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.

func (*Command) IsAvailableCommand Uses

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 Uses

func (c *Command) LocalFlags() *flag.FlagSet

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

func (*Command) LocalNonPersistentFlags Uses

func (c *Command) LocalNonPersistentFlags() *flag.FlagSet

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

func (*Command) MarkFlagCustom Uses

func (c *Command) MarkFlagCustom(name string, f string) error

MarkFlagCustom adds the BashCompCustom annotation to the named flag, if it exists. Generated bash autocompletion will call the bash function f for the flag.

func (*Command) MarkFlagFilename Uses

func (c *Command) MarkFlagFilename(name string, extensions ...string) error

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 Uses

func (c *Command) MarkFlagRequired(name string) error

MarkFlagRequired adds the BashCompOneRequiredFlag annotation to the named flag, if it exists.

func (*Command) MarkPersistentFlagFilename Uses

func (c *Command) MarkPersistentFlagFilename(name string, extensions ...string) error

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 Uses

func (c *Command) MarkPersistentFlagRequired(name string) error

MarkPersistentFlagRequired adds the BashCompOneRequiredFlag annotation to the named persistent flag, if it exists.

func (*Command) Name Uses

func (c *Command) Name() string

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

func (*Command) NameAndAliases Uses

func (c *Command) NameAndAliases() string

NameAndAliases returns a list of the command name and all aliases

func (*Command) NamePadding Uses

func (c *Command) NamePadding() int

NamePadding returns padding for the name.

func (*Command) NonInheritedFlags Uses

func (c *Command) NonInheritedFlags() *flag.FlagSet

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

func (*Command) OutOrStderr Uses

func (c *Command) OutOrStderr() io.Writer

OutOrStderr returns output to stderr

func (*Command) OutOrStdout Uses

func (c *Command) OutOrStdout() io.Writer

OutOrStdout returns output to stdout.

func (*Command) Parent Uses

func (c *Command) Parent() *Command

Parent returns a commands parent command.

func (*Command) ParseFlags Uses

func (c *Command) ParseFlags(args []string) error

ParseFlags parses persistent flag tree and local flags.

func (*Command) PersistentFlags Uses

func (c *Command) PersistentFlags() *flag.FlagSet

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

func (*Command) Print Uses

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) Printf Uses

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 Uses

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) RemoveCommand Uses

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

RemoveCommand removes one or more commands from a parent command.

func (*Command) ResetCommands Uses

func (c *Command) ResetCommands()

ResetCommands delete parent, subcommand and help command from c.

func (*Command) ResetFlags Uses

func (c *Command) ResetFlags()

ResetFlags deletes all flags from command.

func (*Command) Root Uses

func (c *Command) Root() *Command

Root finds root command.

func (*Command) Runnable Uses

func (c *Command) Runnable() bool

Runnable determines if the command is itself runnable.

func (*Command) SetArgs Uses

func (c *Command) SetArgs(a []string)

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) SetFlagErrorFunc Uses

func (c *Command) SetFlagErrorFunc(f func(*Command, error) error)

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

func (*Command) SetGlobalNormalizationFunc Uses

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 Uses

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

SetHelpCommand sets help command.

func (*Command) SetHelpFunc Uses

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

SetHelpFunc sets help function. Can be defined by Application.

func (*Command) SetHelpTemplate Uses

func (c *Command) SetHelpTemplate(s string)

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

func (*Command) SetOutput Uses

func (c *Command) SetOutput(output io.Writer)

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

func (*Command) SetUsageFunc Uses

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

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

func (*Command) SetUsageTemplate Uses

func (c *Command) SetUsageTemplate(s string)

SetUsageTemplate sets usage template. Can be defined by Application.

func (*Command) SuggestionsFor Uses

func (c *Command) SuggestionsFor(typedName string) []string

SuggestionsFor provides suggestions for the typedName.

func (*Command) Traverse Uses

func (c *Command) Traverse(args []string) (*Command, []string, error)

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

func (*Command) Usage Uses

func (c *Command) Usage() error

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 Uses

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 Uses

func (c *Command) UsagePadding() int

UsagePadding return padding for the usage.

func (*Command) UsageString Uses

func (c *Command) UsageString() string

UsageString return usage string.

func (*Command) UsageTemplate Uses

func (c *Command) UsageTemplate() string

UsageTemplate returns usage template for the command.

func (*Command) UseLine Uses

func (c *Command) UseLine() string

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

func (*Command) ValidateArgs Uses

func (c *Command) ValidateArgs(args []string) error

func (*Command) VisitParents Uses

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

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

type PositionalArgs Uses

type PositionalArgs func(cmd *Command, args []string) error

func ExactArgs Uses

func ExactArgs(n int) PositionalArgs

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

func MaximumNArgs Uses

func MaximumNArgs(n int) PositionalArgs

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

func MinimumNArgs Uses

func MinimumNArgs(n int) PositionalArgs

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

func RangeArgs Uses

func RangeArgs(min int, max int) PositionalArgs

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

Directories

PathSynopsis
cobra
cobra/cmd
doc

Package cobra imports 12 packages (graph) and is imported by 5321 packages. Updated 2017-11-17. Refresh now. Tools for package owners.