Documentation
¶
Index ¶
Constants ¶
View Source
const DiscoveryCommandName = "_plugin_commands"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CommandSpec ¶
type CommandSpec struct {
Use string `json:"use"`
Aliases []string `json:"aliases,omitempty"`
SuggestFor []string `json:"suggest_for,omitempty"`
Short string `json:"short,omitempty"`
Long string `json:"long,omitempty"`
Example string `json:"example,omitempty"`
Deprecated string `json:"deprecated,omitempty"`
Annotations map[string]string `json:"annotations,omitempty"`
Version string `json:"version,omitempty"`
TraverseChildren bool `json:"traverse_children,omitempty"`
Hidden bool `json:"hidden,omitempty"`
DisableAutoGenTag bool `json:"disable_auto_gen_tag,omitempty"`
DisableFlagsInUseLine bool `json:"disable_flags_in_use_line,omitempty"`
DisableSuggestions bool `json:"disable_suggestions,omitempty"`
SuggestionsMinimumDistance int `json:"suggestions_minimum_distance,omitempty"`
LocalFlags []FlagSpec `json:"local_flags,omitempty"`
PersistentFlags []FlagSpec `json:"persistent_flags,omitempty"`
Runnable bool `json:"runnable,omitempty"`
SubCommands []CommandSpec `json:"sub_commands,omitempty"`
}
CommandSpec is a serializable object that has all the information that describes a cobra.Command.
func SpecFromCommand ¶
func SpecFromCommand(cmd *cobra.Command) CommandSpec
SpecFromCommand creates a CommandSpec describing a cobra.Command.
type FlagSpec ¶
type FlagSpec struct {
Type string `json:"type,omitempty"`
Name string `json:"name,omitempty"`
Shorthand string `json:"shorthand,omitempty"`
Usage string `json:"usage,omitempty"`
DefaultValue string `json:"default_value,omitempty"`
NoOptDefaultValue string `json:"no_opt_default_value,omitempty"`
Deprecated string `json:"deprecated,omitempty"`
Hidden bool `json:"hidden,omitempty"`
ShorthandDeprecated string `json:"shorthand_deprecated,omitempty"`
Annotations map[string][]string `json:"annotations,omitempty"`
}
FlagSpec is a serializable object that has all the information that describes a pflag.Flag.
func SpecFromFlag ¶
SpecFromFlag creates a FlagSpec describing a flag.
func SpecsFromFlagset ¶
SpecsFromFlagset creates a slice of FlagSpecs from a pflag.FlagSet.
type Spec ¶
type Spec struct {
Commands CommandSpec `json:"commands"`
}
Spec describes a CLI plugin in a serializable format.
Click to show internal directories.
Click to hide internal directories.