hack.foo
Reference

Reference and contracts

Start with the CLI overview to choose a command and the generated command reference for usage and flags. Command and output contracts adds the deeper leaf sections, complete public flag inventory and command-specific JSON/log records. Read Run and inspect for a task sequence rather than using a flag list as an installation guide.

A command being listed is not proof that every backend accepts it. Read the selected version's runtime limits alongside examples. Help's global flags and a parent command table are distinct from complete leaf-command option coverage.

Environment and lifecycle configuration

Environment and secrets, Lifecycle and Architecture explain the project configuration model. Do not infer schema defaults or cloud-provider support from a similarly named field in another version.

Agent interface

The CLI reference and integrations provide the v4 consumer interface. Public MCP implementation is preserved at the pinned source revision. Later v5 compiler schemas and MCP reference pages are not substitutes for the v4 contract. This archived corpus has no generated complete API/type catalog.

Field references

Configuration fields lists the version-specific project JSON, environment YAML and branch registry. MCP fields and results lists every registered tool's input declarations, result fields and log event types.

Project and env reports details the owned inventory, metadata, raw env-list and restart-wrapper projections. Raw CLI env reports are not value-free MCP projections.

Diagnostic and setup reports lists the owned doctor, setup, update and host telemetry types, plus the public candidate-report wrappers where present. Private compiler Plan internals are excluded.

Coverage limits

This first versioned pass preserves generated command documentation and separates public contracts from internal implementation types. Some deeper subcommands lack full generated usage/options sections. Dedicated per-flag and configuration-field coverage remains an explicit follow-up; neither a parent table nor a linked source file counts as a complete prose API specification. No internal DTO is promoted to a supported public API by appearing in the repository.


Source: v4.2.4 · docs/site/reference/overview.md.

On this page