cobra

Documentation

Overview

Package cobra contains embedded resources

Index

• type CommandData
  • func Parse(mod *utilities.ModuleInfo) ([]*CommandData, error)

Types

type CommandData

type CommandData struct {
	// TODO: Eventually need to adjust the installation command based on multiple execution paths.
	// ExecutionRemotePath string `json:""`
	Name    string `json:""`
	Use     string `json:""`
	UseLine string `json:""`
	Long    string `json:""`
	Short   string `json:""`
	Example string `json:""`
	// HasExample determines if the command has example.
	HasExample bool `json:""`
	// Runnable determines if the command is itself runnable.
	Runnable bool `json:""`
	// HasSubCommands determines if the command has children commands.
	HasSubCommands bool           `json:""`
	SubCommands    []*CommandData `json:""`

	// IsAvailableCommand determines if a command is available as a non-help command
	// (this includes all non deprecated/hidden commands).
	IsAvailableCommand bool     `json:""`
	PersistentFlags    []string `json:""`
	LocalFlags         []string `json:""`
}

CommandData is the aggregated documentation data from a Cobra command. Must remain in the parse.go file to be transferred into the cobra directory. This file should only import from cobra and the standard library.

func Parse

func Parse(mod *utilities.ModuleInfo) ([]*CommandData, error)