cobra

package
v1.0.3 Latest Latest
Warning

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

 Go to latest Published: Oct 20, 2015 License: Apache-2.0 Imports: 13 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_extentions"
	BashCompOneRequiredFlag = "cobra_annotation_bash_completion_one_required_flag"
)

Variables

View Source 
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

View Source 
var EnableWindowsMouseTrap bool = true

enables an information splash screen on Windows if the CLI is started from explorer.exe.

View Source 
var MousetrapHelpText string = `This is a command line tool

You need to open cmd.exe and run it from there.
`

Functions

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 GenMarkdown added in v1.0.1 

func GenMarkdown(cmd *Command, out *bytes.Buffer)

func GenMarkdownTree added in v1.0.1 

func GenMarkdownTree(cmd *Command, dir string)

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

	// 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)
	// PreRun: children of this command will not inherit.
	PreRun func(cmd *Command, args []string)
	// Run: Typically the actual work function. Most commands will only implement this
	Run func(cmd *Command, args []string)
	// PostRun: run after the Run command.
	PostRun func(cmd *Command, args []string)
	// PersistentPostRun: children of this command will inherit and execute after PostRun
	PersistentPostRun func(cmd *Command, args []string)
	// 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) 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 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() (err 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) Find 

func (c *Command) Find(arrs []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)

Climbs up the command tree looking for matching flag

func (*Command) Flags 

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

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

func (*Command) GenBashCompletion added in v1.0.1 

func (cmd *Command) GenBashCompletion(out *bytes.Buffer)

func (*Command) GenBashCompletionFile added in v1.0.1 

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

func (*Command) HasAlias 

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

Determine if a given string is an alias of the command.

func (*Command) HasExample added in v1.0.1 

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 added in v1.0.1 

func (c *Command) HasHelpSubCommands() bool

func (*Command) HasInheritedFlags added in v1.0.1 

func (c *Command) HasInheritedFlags() bool

func (*Command) HasLocalFlags added in v1.0.1 

func (c *Command) HasLocalFlags() bool

Does the command has flags specifically declared locally

func (*Command) HasParent 

func (c *Command) HasParent() bool

Determine if the command is a child command

func (*Command) HasPersistentFlags 

func (c *Command) HasPersistentFlags() bool

Does the command contain persistent flags

func (*Command) HasRunnableSiblings added in v1.0.1 

func (c *Command) HasRunnableSiblings() bool

func (*Command) HasRunnableSubCommands added in v1.0.1 

func (c *Command) HasRunnableSubCommands() bool

Determine if the command has runnable children commands

func (*Command) HasSubCommands 

func (c *Command) HasSubCommands() bool

Determine if the command has children commands

func (*Command) Help 

func (c *Command) Help() error

Output the help for the command Used when a user calls help [command] by the default HelpFunc in the commander

func (*Command) HelpFunc 

func (c *Command) HelpFunc() func(*Command, []string)

func (*Command) HelpTemplate 

func (c *Command) HelpTemplate() string

func (*Command) InheritedFlags added in v1.0.1 

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

All Flags which were inherited from parents commands

func (*Command) LocalFlags added in v1.0.1 

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

Get the local FlagSet specifically set in the current command

func (*Command) MarkFlagRequired added in v1.0.1 

func (cmd *Command) MarkFlagRequired(name string)

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 added in v1.0.1 

func (c *Command) NamePadding() int

func (*Command) NonInheritedFlags added in v1.0.1 

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

All Flags which were not inherited from parent commands

func (*Command) Out 

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

func (*Command) Parent 

func (c *Command) Parent() *Command

func (*Command) ParseFlags 

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

Parses persistent flag tree & local flags

func (*Command) PersistentFlags 

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

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

func (c *Command) Printf(format string, i ...interface{})

Convenience method to Printf to the defined output

func (*Command) Println 

func (c *Command) Println(i ...interface{})

Convenience method to Println to the defined output

func (*Command) RemoveCommand added in v1.0.1 

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

AddCommand 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()

For use in testing

func (*Command) Root 

func (c *Command) Root() *Command

func (*Command) Runnable 

func (c *Command) Runnable() bool

Determine 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) 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) Usage 

func (c *Command) Usage() error

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

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

The full usage for a given command (including parents)

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.