Documentation
¶
Overview ¶
Package cmd provides the command-line interface for the Corral application.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Version = "dev"
Version is the build version of Corral. It is overridden at release time via -ldflags "-X github.com/sebastienrousseau/corral/cmd.Version=<version>" (set by goreleaser) and by `make build` via `git describe`. The "dev" fallback makes an un-injected build obviously local rather than masquerading as a stale release tag.
Functions ¶
func Execute ¶
func Execute()
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func ExecuteContext ¶ added in v0.0.3
ExecuteContext executes the root command with the provided context.
func RootCommand ¶ added in v0.0.28
RootCommand returns the fully configured root command.
Exposed so build-time tooling can walk the command tree — scripts/gen_docs.go renders manpages and shell completions from it, which is what keeps both in step with `--help` instead of drifting as hand-written files do. Callers must treat the result as read-only; mutating it changes what the CLI does.
Types ¶
type ExecSummary ¶ added in v0.0.14
ExecSummary is the aggregate outcome of a batch command.
Source Files
Directories