cmd

Documentation

Index

• func CommandStr() string
• func Execute()
• func MakeCommands() *cobra.Command
• type ExampleSchema
• type ExampleUsageSchema
• type OrbSchema

Functions

func CommandStr

func CommandStr() string

Returns a string (e.g. "circleci context list") indicating what subcommand is being called, without any args or flags, for API headers.

func Execute

func Execute()

Execute adds all child commands to rootCmd and sets flags appropriately. This function is called by main.main(). It only needs to happen once to the rootCmd.

func MakeCommands

func MakeCommands() *cobra.Command

MakeCommands creates the top level commands

Types

type ExampleSchema

type ExampleSchema struct {
	Description string             `yaml:"description,omitempty"`
	Usage       ExampleUsageSchema `yaml:"usage,omitempty"`
	Result      ExampleUsageSchema `yaml:"result,omitempty"`
}

type ExampleUsageSchema

type ExampleUsageSchema struct {
	Version   string      `yaml:"version,omitempty"`
	Setup     bool        `yaml:"setup,omitempty"`
	Orbs      interface{} `yaml:"orbs,omitempty"`
	Jobs      interface{} `yaml:"jobs,omitempty"`
	Workflows interface{} `yaml:"workflows"`
}

type OrbSchema

type OrbSchema struct {
	Version     float32                  `yaml:"version,omitempty"`
	Description string                   `yaml:"description,omitempty"`
	Display     yaml.Node                `yaml:"display,omitempty"`
	Orbs        yaml.Node                `yaml:"orbs,omitempty"`
	Commands    yaml.Node                `yaml:"commands,omitempty"`
	Executors   yaml.Node                `yaml:"executors,omitempty"`
	Jobs        yaml.Node                `yaml:"jobs,omitempty"`
	Examples    map[string]ExampleSchema `yaml:"examples,omitempty"`
}