README
¶
Commands
A set of consistent Cobra commands that can be used to implement common functionality for tools.
Includes:
root: Application entry point, config loading, and service orchestrationinit: Interactive first-run configuration and credential setupversion: Version display and update checkingupdate: Self-updating from signed releasesdocs: Interactive TUI documentation browsermcp: AI agent integration (Model Context Protocol)doctor: Environment and configuration health checksconfig: Get/set/unset/edit/validate/migrate configurationchangelog: Embedded version historytelemetry: Opt-in pseudonymous usage analyticsman: Roff man-page generation (opt-in)
Which commands are active is controlled by feature flags — see props.SetFeatures.
For detailed reference, usage, and feature-flag behaviour, see the CLI command reference.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package changelog provides the `changelog` command for displaying version history from an embedded CHANGELOG.md, with optional version and since-tag filtering.
|
Package changelog provides the `changelog` command for displaying version history from an embedded CHANGELOG.md, with optional version and since-tag filtering. |
|
Package config implements the "config" CLI command and its subcommands for programmatic read/write access to individual configuration keys.
|
Package config implements the "config" CLI command and its subcommands for programmatic read/write access to individual configuration keys. |
|
Package docs provides the Cobra `docs` command for browsing this tool's embedded documentation in a terminal (an interactive Bubble Tea browser), with two subcommands: `serve` (host the docs as a static HTTP site) and `ask` (AI-assisted Q&A grounded in the bundled docs at runtime).
|
Package docs provides the Cobra `docs` command for browsing this tool's embedded documentation in a terminal (an interactive Bubble Tea browser), with two subcommands: `serve` (host the docs as a static HTTP site) and `ask` (AI-assisted Q&A grounded in the bundled docs at runtime). |
|
Package doctor provides a diagnostic command that validates configuration, checks environment health, and reports runtime details.
|
Package doctor provides a diagnostic command that validates configuration, checks environment health, and reports runtime details. |
|
Package initialise provides the Cobra command for bootstrapping a new tool's configuration directory and default config file, running registered setup.Initialiser hooks in sequence.
|
Package initialise provides the Cobra command for bootstrapping a new tool's configuration directory and default config file, running registered setup.Initialiser hooks in sequence. |
|
Package man implements the hidden, opt-in "man" command that emits roff man pages for a tool's own command tree at runtime — for packaging postinstall scripts or ad-hoc preview — without re-running the source-tree generator.
|
Package man implements the hidden, opt-in "man" command that emits roff man pages for a tool's own command tree at runtime — for packaging postinstall scripts or ad-hoc preview — without re-running the source-tree generator. |
|
Package root provides the reusable root Cobra command constructor that wires configuration loading, logging setup, update checks, and feature-flagged subcommand registration (version, update, init, doctor, config, telemetry, changelog, man, MCP, docs).
|
Package root provides the reusable root Cobra command constructor that wires configuration loading, logging setup, update checks, and feature-flagged subcommand registration (version, update, init, doctor, config, telemetry, changelog, man, MCP, docs). |
|
Package telemetry provides the `telemetry` command group for managing pseudonymous usage telemetry: enable, disable, status, and reset subcommands.
|
Package telemetry provides the `telemetry` command group for managing pseudonymous usage telemetry: enable, disable, status, and reset subcommands. |
|
Package update provides the Cobra command for self-updating the CLI binary to the latest released version from the configured release source (GitHub or GitLab), with support for private repositories via token authentication.
|
Package update provides the Cobra command for self-updating the CLI binary to the latest released version from the configured release source (GitHub or GitLab), with support for private repositories via token authentication. |
|
Package version provides the Cobra command for displaying the CLI's current version, build date, and commit information.
|
Package version provides the Cobra command for displaying the CLI's current version, build date, and commit information. |
Click to show internal directories.
Click to hide internal directories.