Documentation CLI 0.1.1 · development llms.txt

coldctl archive plan

Preview an estimated archive operation.

ImplementedDatabase read

Syntax

USAGE

coldctl archive plan [OPTIONS] <POLICY>

Arguments & options

Argument	Description
`<POLICY>`	Name of a saved policy.

Option	Description / default
`--data-dir <PATH>`	Override the OS application data directory
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`-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 archive plan orders-archive --output json

Operational notes

Uses the source connector to validate supported shape and preview retention bounds. Planning creates no archive files and does not prove destination access or source stability. Estimates are not completion percentages.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Validate and estimate without reading table rows or writing archive files

Usage: coldctl archive plan [OPTIONS] <POLICY>

Arguments:
  <POLICY>  

Options:
      --data-dir <PATH>  Override the OS application data directory
      --output <OUTPUT>  [default: table] [possible values: table, json]
  -h, --help             Print help