Documentation CLI 0.1.1 · development llms.txt

coldctl archive shadow

Compare source, archive and gateway.

ImplementedRead-only validation and local evidence

Syntax

USAGE

coldctl archive shadow [OPTIONS] --confirm-original-source <ID>

Arguments & options

Argument	Description
`<ID>`	Completed archive job ID

Option	Description / default
`--confirm-original-source`	Confirm the original source still retains the archived records
`--data-dir <PATH>`	Override the OS application data directory
`--output <OUTPUT>`	[default: table] [possible values: table, json]
`--max-batches <MAX_BATCHES>`	Stop after this many batches; a partial report cannot pass
`--gateway-batch-size <GATEWAY_BATCH_SIZE>`	Keys per Gateway request (1-100); defaults to 64
`--max-duration-seconds <MAX_DURATION_SECONDS>`	Stop after this duration; partial coverage cannot pass. Blocking storage I/O may finish first
`--gateway-url <GATEWAY_URL>`	Gateway HTTPS origin (HTTP is allowed only on loopback)
`--dataset-id <DATASET_ID>`	Gateway dataset ID containing this archive
`--token-env <TOKEN_ENV>`	Environment variable containing the gateway bearer token
`-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 shadow JOB_ID --confirm-original-source --gateway-url https://archive.example.com --dataset-id DATASET_ID --token-env COLDCTL_GATEWAY_TOKEN

Operational notes

Read-only ID lookup comparison over the saved archive range. Requires retained stable source data and no deletion history. Partial, mismatch and error reports return nonzero; no secrets or row values are persisted.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Compare a completed archive with retained source rows and optional gateway ID lookups. Never deletes

Usage: coldctl archive shadow [OPTIONS] --confirm-original-source <ID>

Arguments:
  <ID>  Completed archive job ID

Options:
      --confirm-original-source
          Confirm the original source still retains the archived records
      --data-dir <PATH>
          Override the OS application data directory
      --output <OUTPUT>
          [default: table] [possible values: table, json]
      --max-batches <MAX_BATCHES>
          Stop after this many batches; a partial report cannot pass
      --gateway-batch-size <GATEWAY_BATCH_SIZE>
          Keys per Gateway request (1-100); defaults to 64
      --max-duration-seconds <MAX_DURATION_SECONDS>
          Stop after this duration; partial coverage cannot pass. Blocking storage I/O may finish first
      --gateway-url <GATEWAY_URL>
          Gateway HTTPS origin (HTTP is allowed only on loopback)
      --dataset-id <DATASET_ID>
          Gateway dataset ID containing this archive
      --token-env <TOKEN_ENV>
          Environment variable containing the gateway bearer token
  -h, --help
          Print help