package cobra

import "k8s.io/kubernetes/Godeps/_workspace/src/github.com/spf13/cobra"

Index ¶

• Variables
• func Eq(a interface{}, b interface{}) bool
• func Gt(a interface{}, b interface{}) bool
• func OnInitialize(y ...func())
• type Command
• func (c *Command) AddCommand(cmds ...*Command)
• func (c *Command) CommandPath() string
• func (c *Command) CommandPathPadding() int
• func (c *Command) Commands() []*Command
• func (c *Command) DebugFlags()
• func (c *Command) Execute() (err error)
• func (c *Command) Find(arrs []string) (*Command, []string, error)
• func (c *Command) Flag(name string) (flag *flag.Flag)
• func (c *Command) Flags() *flag.FlagSet
• func (c *Command) HasAlias(s string) bool
• func (c *Command) HasFlags() 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) Name() string
• func (c *Command) NameAndAliases() string
• 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) ResetCommands()
• func (c *Command) ResetFlags()
• func (c *Command) Root() *Command
• func (c *Command) Runnable() bool
• func (c *Command) SetArgs(a []string)
• 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) 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

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 Eq ¶

func Eq(a interface{}, b interface{}) bool

func Gt ¶

func Gt(a interface{}, b interface{}) bool

func OnInitialize ¶

func OnInitialize(y ...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

	// Run runs the command.
	// The args are the arguments after the command name.
	Run 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)

Add one or many commands as children of this

func (*Command) CommandPath ¶

func (c *Command) CommandPath() string

The full path to this command

func (*Command) CommandPathPadding ¶

func (c *Command) CommandPathPadding() int

func (*Command) Commands ¶

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

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 Commands FlagSet

func (*Command) HasAlias ¶

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

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

func (*Command) HasFlags ¶

func (c *Command) HasFlags() bool

Does the command contain flags (local not persistent)

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) 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) 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) 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 Commands Persistent FlagSet

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

cobra.go command.go