Documentation CLI 0.1.1 · development llms.txt

CLI conventions

Global flags, output streams, identifiers and placeholder syntax.

Global options

--data-dir PATH selects local state for any command. --help prints usage for a command. --version prints the CLI version at the root. coldctl help COMMAND also displays help. init/status have no --output option. agent sync --dry-run emits JSON; its successful upload emits a human-readable message.

CLI

coldctl --help
coldctl help archive run
coldctl --version

Structured output

Commands that expose --output accept table|json. Scheduler commands and connector inventory operations emit their documented structured results without a universal --output flag. Progress and diagnostics go to stderr. Errors exit nonzero; a bounded pause can exit successfully, so inspect the returned status. Exact flags for each command appear in the command reference.

CLI

coldctl jobs show JOB_ID --output json

Example notation

Replace JOB_ID with an actual job UUID and names such as production or orders-archive with local configuration names. Paths are examples; create required parent directories. Commands are shown one per line without shell-specific continuation characters. Supply secrets via the environment or a secret manager, not command-line URLs.

Availability

Implemented: optional PostgreSQL/MySQL/MongoDB connectors, local/S3/Azure/GCS archival, checkpoint recovery, same-engine separate-target restore, verified deletion, a durable scheduler and explicit recurring PostgreSQL/MySQL/MongoDB-to-S3/Azure/GCS archive/delete cycles. The separate customer-hosted gateway retrieves supported archives. CDC, mutable-source snapshots, distributed scheduling remain outside this workflow; optional agent sync --watch provides background metadata uploads. Use agent scheduler run for the local worker.