cmd

Documentation

Index

• func AddCommands(commands ...*cobra.Command)
• func Execute() error
• type CommandInfo
• type FlagInfo
• type GlobalFlags
  • func GetGlobalFlags() GlobalFlags

Functions

func AddCommands

func AddCommands(commands ...*cobra.Command)

AddCommands adds all subcommands to root

func Execute

func Execute() error

Execute adds all child commands to the root command and sets flags appropriately.

Types

type CommandInfo

type CommandInfo struct {
	Name        string        `json:"name"`
	Use         string        `json:"use"`
	Short       string        `json:"short"`
	Long        string        `json:"long"`
	Subcommands []CommandInfo `json:"subcommands,omitempty"`
	Flags       []FlagInfo    `json:"flags,omitempty"`
	Examples    string        `json:"examples,omitempty"`
}

CommandInfo represents metadata about a command for introspection

type FlagInfo

type FlagInfo struct {
	Name      string `json:"name"`
	Shorthand string `json:"shorthand,omitempty"`
	Usage     string `json:"usage"`
	DefValue  string `json:"default,omitempty"`
	Required  bool   `json:"required"`
}

type GlobalFlags

type GlobalFlags struct {
	APIKey       string
	OutputFormat string
	OutputFile   string
	Verbose      bool
	Quiet        bool
	DryRun       bool
}

GlobalFlags holds all global flag values

func GetGlobalFlags

func GetGlobalFlags() GlobalFlags

GetGlobalFlags returns the current global flag values