Documentation CLI 0.1.1 · development llms.txt

coldctl archive inspect

Read a standalone archive manifest.

ImplementedLocal read

Syntax

USAGE

coldctl archive inspect [OPTIONS] <DIRECTORY>

Arguments & options

Argument	Description
`<DIRECTORY>`	Completed archive directory named with its original job UUID.

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 inspect ./archives/JOB_ID --output json

Operational notes

Keep the directory named with its original job UUID. Inspects supported formats 2 (PostgreSQL), 3 (MySQL) and 4 (MongoDB) without verifying every archive object. No source credentials are needed.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Inspect a format-v2 manifest without the original state or database

Usage: coldctl archive inspect [OPTIONS] <DIRECTORY>

Arguments:
  <DIRECTORY>  

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