tree

type Arg struct {
	Name        string
	Description string
	Repeat      bool
	Optional    bool
	Suggest     func(ctx context.Context, t Root, r *readline.Readline) []goprompt.Suggest
}

type ArgInfo struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Optional    bool   `json:"optional,omitempty"`
	// Repeat marks an argument that may be given more than once. Only the last
	// argument of a command can repeat.
	Repeat bool `json:"repeat,omitempty"`
}

type Args []*Arg

type CommandInfo struct {
	// FullPath is the command as typed, e.g. "cache clear".
	FullPath    string `json:"full_path"`
	Description string `json:"description"`
	// Dynamic marks a node whose name is resolved at runtime (a cluster name,
	// a cache key, ...). Its FullPath carries a "<placeholder>" instead of a
	// literal name - run the command to discover the actual values.
	Dynamic     bool          `json:"dynamic,omitempty"`
	Arguments   []ArgInfo     `json:"arguments,omitempty"`
	Flags       []FlagInfo    `json:"flags,omitempty"`
	Subcommands []CommandInfo `json:"subcommands,omitempty"`
}

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

type Node struct {
	Name        string
	Values      func(ctx context.Context, r *readline.Readline) []goprompt.Suggest
	Args        Args
	Flags       func(ctx context.Context, r *readline.Readline, fs *readline.FlagSets) error
	Description string
	Nodes       []*Node
	Execute     func(ctx context.Context, r *readline.Readline) error
}

type Nodes []*Node

type Root interface {
	Node() *Node
	Describe(ctx context.Context) CommandInfo
	Complete(ctx context.Context, r *readline.Readline) []goprompt.Suggest
	Execute(ctx context.Context, r *readline.Readline) error
	Help(ctx context.Context, r *readline.Readline) string
}