Documentation
¶
Overview ¶
Package cobra adapts conductor to cobra-based CLIs: one call wires themed help, shell completions, standard flags, version output and update notifications onto an existing root command, mirroring the conventions of clib's cli/cobra package.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func UpdateCommand ¶
UpdateCommand returns the standard self-update subcommand. It dispatches on App.Updater's install method (brew, goinstall or github); tools distributed another way provide their own update command instead.
Types ¶
type Flags ¶
Flags are the standard persistent flags: verbosity and color. New registers them on the root command's persistent flag set and applies them to clog in the chained PersistentPreRunE.
func (*Flags) ConductorFlags ¶
ConductorFlags implements conductor.FlagSource.
type Option ¶
type Option func(*Program)
Option configures New.
func WithExitCode ¶
WithExitCode maps command errors to exit codes; see conductor.ExitCode.
func WithGenerator ¶
WithGenerator customises the completion generator before completion actions run, e.g. to add dynamic argument specs.
func WithSections ¶
func WithSections(opts ...clibcobra.SectionsOption) Option
WithSections configures the help section builder.
func WithUpdateCommand ¶
func WithUpdateCommand() Option
WithUpdateCommand adds the standard Homebrew `update` subcommand.
func WithVersionCommand ¶
func WithVersionCommand() Option
WithVersionCommand adds the standard `version` subcommand.
type Program ¶
type Program struct {
Runtime *conductor.Runtime
Root *cobralib.Command
Completion *clibcobra.Completion
Flags *Flags
// contains filtered or unexported fields
}
Program is the assembled cobra CLI. All fields are exported and may be customised between New and Program.Run.
func New ¶
New wires conductor onto root: identity defaults from the App, themed help, persistent standard flags, a -V/--version flag, completion flags, and a chained PersistentPreRunE that applies the standard flags and starts the update notification once the command is resolved. Add subcommands to root before or after New; the completion generator is built at Run time.
Source Files