clihelp

type Command struct {
	// Name is the first word of Use; Path is how you would type it,
	// e.g. "skywire cli visor info". Both are given because callers want
	// different ones: Name to match, Path to run.
	Name    string `json:"name"`
	Path    string `json:"path"`
	Use     string `json:"use,omitempty"`
	Short   string `json:"short,omitempty"`
	Long    string `json:"long,omitempty"`
	Example string `json:"example,omitempty"`

	Aliases    []string `json:"aliases,omitempty"`
	Deprecated string   `json:"deprecated,omitempty"`
	Hidden     bool     `json:"hidden,omitempty"`
	// Runnable distinguishes a command that does something from a group that
	// only holds subcommands.
	Runnable bool `json:"runnable"`

	// Flags are declared on this command; Inherited come from ancestors
	// (--json among them). Kept apart because the distinction decides where
	// a flag may be placed on the command line.
	Flags     []Flag `json:"flags,omitempty"`
	Inherited []Flag `json:"inherited_flags,omitempty"`

	Subcommands []Command `json:"subcommands,omitempty"`
}

type Flag struct {
	Name string `json:"name"`
	// Shorthand is the single-letter form without its dash, empty if none.
	Shorthand string `json:"shorthand,omitempty"`
	// Type is pflag's own name for the value: "string", "bool", "int",
	// "stringSlice" and so on. It is what tells a caller whether the flag
	// takes an argument.
	Type       string `json:"type"`
	Default    string `json:"default,omitempty"`
	Usage      string `json:"usage,omitempty"`
	Deprecated string `json:"deprecated,omitempty"`
	Hidden     bool   `json:"hidden,omitempty"`
}

type Node struct {
	Name string `json:"name"`
	// Path is how the command is typed, e.g. "skywire cli visor info".
	Path string `json:"path"`
	// Runnable separates a command that does something from a group that only
	// holds others — the distinction the ASCII rendering cannot show.
	Runnable bool   `json:"runnable"`
	Children []Node `json:"children,omitempty"`
}