README
¶
Commands
A set of consistent Cobra commands that can be used to implement common functionality for tools.
Includes:
root: Application entry point and service orchestrationinit: Tool configuration and environment setupversion: Version display and update checkingupdate: Automated binary updates and migrationdocs: Interactive TUI documentation browsermcp: AI agent integration (Model Context Protocol)
For detailed documentation, usage examples, and integration guides, see the Built-in Commands Documentation.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package changelog provides the changelog command for displaying version history from an embedded CHANGELOG.md.
|
Package changelog provides the changelog command for displaying version history from an embedded CHANGELOG.md. |
|
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 command for launching the interactive documentation browser, with optional AI-powered content enhancement during generation.
|
Package docs provides the Cobra command for launching the interactive documentation browser, with optional AI-powered content enhancement during generation. |
|
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 root provides the reusable root Cobra command constructor that wires configuration loading, logging setup, update checks, and feature-flagged subcommand registration (version, update, init, docs, MCP).
|
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, docs, MCP). |
|
Package telemetry provides CLI commands for managing anonymous usage telemetry.
|
Package telemetry provides CLI commands for managing anonymous usage telemetry. |
|
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.