docs

Documentation

Index

• func FindCommand(root *cobra.Command, args []string) (*cobra.Command, error)
• func GenMdxTree(cmd *cobra.Command, dir string) error
• func GenYamlTree(cmd *cobra.Command, dir string) error
• type Command
  • func DescribeCommand(cmd *cobra.Command) Command
  • func (cmd Command) ExamplesList() []Example
• type Example
• type Flag

Functions

func FindCommand

func FindCommand(root *cobra.Command, args []string) (*cobra.Command, error)

FindCommand resolves a command path against the provided root command.

func GenMdxTree

func GenMdxTree(cmd *cobra.Command, dir string) error

func GenYamlTree

func GenYamlTree(cmd *cobra.Command, dir string) error

Types

type Command

type Command struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Usage       string   `json:"usage"`
	Aliases     []string `json:"aliases,omitempty"`
	Examples    string   `json:"examples,omitempty"`
	Slug        string   `json:"slug,omitempty"`
	RunInWebCLI bool     `json:"runInWebCLI,omitempty"`
	CommandType string   `json:"commandType"`

	Annotations map[string]string `json:"annotations,omitempty"`

	Flags map[string][]Flag `json:"flags,omitempty"`

	SubCommands []Command `json:"subCommands,omitempty"`
}

func DescribeCommand

func DescribeCommand(cmd *cobra.Command) Command

DescribeCommand returns a machine-readable description of a command.

func (Command) ExamplesList

func (cmd Command) ExamplesList() []Example

type Example

type Example struct {
	Desc          string
	Code          string
	WebCLICommand string
}

type Flag

type Flag struct {
	Name        string `json:"name"`
	Shorthand   string `json:"shorthand,omitempty"`
	Description string `json:"description"`
	Default     string `json:"default"`
}