Documentation
¶
Overview ¶
Package meta provides the "jira meta" command group for CLI introspection.
Index ¶
- Constants
- func MarkRequired(cmd *cobra.Command, names ...string)
- func NewCmdCommands(f *factory.Factory) *cobra.Command
- func NewCmdMeta(f *factory.Factory) *cobra.Command
- func NewCmdVersion(f *factory.Factory) *cobra.Command
- type ArgInfo
- type CommandInfo
- type CommandsOptions
- type FlagInfo
- type VersionInfo
- type VersionOptions
Constants ¶
const RequiredAnnotation = "jira_required"
RequiredAnnotation is a custom flag annotation key used to signal that a flag is required for meta commands discovery, without triggering Cobra's built-in required-flag enforcement (which would replace custom CLIError messages with Cobra's generic error).
Variables ¶
This section is empty.
Functions ¶
func MarkRequired ¶
MarkRequired marks a flag as required for meta commands discovery. Unlike Cobra's MarkFlagRequired, this does not change runtime validation.
func NewCmdCommands ¶
NewCmdCommands creates the "meta commands" command.
func NewCmdMeta ¶
NewCmdMeta creates the "meta" command group.
Types ¶
type ArgInfo ¶
type ArgInfo struct {
Name string `json:"name"`
Required bool `json:"required"`
Description string `json:"description"`
}
ArgInfo describes a positional argument.
type CommandInfo ¶
type CommandInfo struct {
Command string `json:"command"`
Description string `json:"description"`
Args []ArgInfo `json:"args"`
Flags []FlagInfo `json:"flags"`
}
CommandInfo describes a single CLI command for machine consumption.
type CommandsOptions ¶
CommandsOptions holds all resolved inputs for the meta commands command.
type FlagInfo ¶
type FlagInfo struct {
Name string `json:"name"`
Type string `json:"type"`
Required bool `json:"required"`
Default string `json:"default"`
Description string `json:"description"`
}
FlagInfo describes a command flag.
type VersionInfo ¶
type VersionInfo struct {
Version string `json:"version"`
API string `json:"api"`
Instance *string `json:"instance"`
}
VersionInfo describes the CLI version for machine consumption.
Source Files