Documentation CLI 0.1.1 · development llms.txt

coldctl state backup

Create a consistent SQLite backup.

ImplementedLocal file write

Syntax

USAGE

coldctl state backup [OPTIONS] --to <TO>

Arguments & options

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--to <TO>`	New file outside the state directory; its parent must already exist
`-h, --help`	Print help

Examples

Replace configuration names, paths and JOB_ID with values from your installation. Examples are not executed by this page.

CLI

coldctl state backup --to ./backups/state-2026-10-05.db --output json

Operational notes

Create the parent directory first. The output must be outside the state directory and must not exist. Uses SQLite online backup, including committed WAL data. Archives, staging files, credentials and locks are not included; stop all writers for a matching state-and-files recovery set.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Consistent SQLite snapshot, including WAL; archive files are not copied

Usage: coldctl state backup [OPTIONS] --to <TO>

Options:
      --data-dir <PATH>  Override the OS application data directory
      --output <OUTPUT>  [default: table] [possible values: table, json]
      --to <TO>          New file outside the state directory; its parent must already exist
  -h, --help             Print help