Documentation CLI 0.1.1 · development llms.txt

coldctl policy show

Inspect a policy and its rule.

ImplementedLocal read

Syntax

USAGE

coldctl policy show [OPTIONS] <NAME>

Arguments & options

Argument	Description
`<NAME>`	Existing local configuration name.

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 policy show orders-archive --output json

Operational notes

Shows the saved source, destination, dataset, time field, retention and batch size. Deletion is authorized separately through archive delete or scheduler --delete-after-archive.

Output, placeholders & global flags

View exact CLI help

HELP OUTPUT

Usage: coldctl policy show [OPTIONS] <NAME>

Arguments:
  <NAME>  

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