cobra

package
v1.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2018 License: Apache-2.0, Apache-2.0 Imports: 12 Imported by: 0

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

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"
)

Variables

View Source 
var EnableCommandSorting = true

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

func AddTemplateFuncs(tmplFuncs template.FuncMap)

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 MarkFlagCustom 

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 

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 

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 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 that are accepted in bash completions
	ValidArgs []string
	// List of aliases for ValidArgs. These are not suggested to the user in the bash
	// completion, but accepted if entered manually.
	ArgAliases []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

	// Disable the flag parsing. If this is true all flags will be passed to the command as arguments.
	DisableFlagParsing bool
	// 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 

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

AddCommand adds one or more commands to this parent command.

func (*Command) ArgsLenAtDash 

func (c *Command) ArgsLenAtDash() int

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 

func (c *Command) CommandPath() string

CommandPath returns the full path to this command.

func (*Command) CommandPathPadding 

func (c *Command) CommandPathPadding() int

func (*Command) Commands 

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

Commands returns a sorted slice of child commands.

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 

func (c *Command) Execute() error

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) ExecuteC 

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

func (*Command) Find 

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 

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

Flag climbs up the command tree looking for matching flag.

func (*Command) FlagErrorFunc 

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 

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

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

func (*Command) GenBashCompletion 

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

func (*Command) GenBashCompletionFile 

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

func (*Command) GlobalNormalizationFunc 

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 

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

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

func (*Command) HasAvailableFlags 

func (c *Command) HasAvailableFlags() bool

Does the command contain any flags (local plus persistent from the entire structure) which are not hidden or deprecated.

func (*Command) HasAvailableInheritedFlags 

func (c *Command) HasAvailableInheritedFlags() bool

Does the command have flags inherited from its parent command which are not hidden or deprecated.

func (*Command) HasAvailableLocalFlags 

func (c *Command) HasAvailableLocalFlags() bool

Does the command has flags specifically declared locally which are not hidden or deprecated.

func (*Command) HasAvailablePersistentFlags 

func (c *Command) HasAvailablePersistentFlags() bool

Does the command contain 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

func (*Command) HasFlags 

func (c *Command) HasFlags() bool

Does the command contain 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

Does the command have flags inherited from its parent command.

func (*Command) HasLocalFlags 

func (c *Command) HasLocalFlags() bool

Does 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

Does the command contain persistent flags.

func (*Command) HasSubCommands 

func (c *Command) HasSubCommands() bool

HasSubCommands determines if the command has children commands.

func (*Command) Help 

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 

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 

func (c *Command) HelpTemplate() string

func (*Command) InheritedFlags 

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

InheritedFlags returns all flags which were inherited from parents commands.

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) IsHelpCommand 

func (c *Command) IsHelpCommand() bool

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 

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

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

func (*Command) LocalNonPersistentFlags 

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

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

func (*Command) MarkFlagCustom 

func (cmd *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 

func (cmd *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 

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

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

func (*Command) MarkPersistentFlagFilename 

func (cmd *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 

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

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

func (*Command) Name 

func (c *Command) Name() string

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

func (*Command) NameAndAliases 

func (c *Command) NameAndAliases() string

func (*Command) NamePadding 

func (c *Command) NamePadding() int

func (*Command) NonInheritedFlags 

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

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

func (*Command) OutOrStderr 

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

func (*Command) OutOrStdout 

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

func (*Command) Parent 

func (c *Command) Parent() *Command

Parent returns a commands parent command.

func (*Command) ParseFlags 

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

ParseFlags parses persistent flag tree and local flags.

func (*Command) PersistentFlags 

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

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

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

RemoveCommand removes one or more commands from a parent command.

func (*Command) ResetCommands 

func (c *Command) ResetCommands()

Used for testing.

func (*Command) ResetFlags 

func (c *Command) ResetFlags()

ResetFlags is used in testing.

func (*Command) Root 

func (c *Command) Root() *Command

func (*Command) Runnable 

func (c *Command) Runnable() bool

Runnable determines if the command is itself runnable.

func (*Command) SetArgs 

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

os.Args[1:] by default, if desired, can be overridden particularly useful when testing.

func (*Command) SetFlagErrorFunc 

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

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

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 (c *Command) SetHelpCommand(cmd *Command)

func (*Command) SetHelpFunc 

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

Can be defined by Application

func (*Command) SetHelpTemplate 

func (c *Command) SetHelpTemplate(s string)

Can be defined by Application.

func (*Command) SetOutput 

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 

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

Usage can be defined by application.

func (*Command) SetUsageTemplate 

func (c *Command) SetUsageTemplate(s string)

Can be defined by Application.

func (*Command) SuggestionsFor 

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

func (*Command) Usage 

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 

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

func (*Command) UsageString 

func (c *Command) UsageString() string

func (*Command) UsageTemplate 

func (c *Command) UsageTemplate() string

func (*Command) UseLine 

func (c *Command) UseLine() string

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

func (*Command) VisitParents 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.