Documentation CLI 0.1.1 · development llms.txt
COMMAND REFERENCE / DESTINATIONS

coldctl destination add local

Register a local archive directory.

ImplementedLocal state write

Syntax

USAGE
coldctl destination add local [OPTIONS] --name <NAME> --path <PATH>

Arguments & options

OptionDescription / default
--data-dir <PATH>Override the OS application data directory
--name <NAME>Unique local name (ASCII letters, digits, hyphens, underscores)
--output <OUTPUT>[default: table] [possible values: table, json]
--path <PATH>Archive directory. Saved as an absolute path; created by destination test if missing
-h, --helpPrint help

Examples

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

CLI
coldctl destination add local --name local-archive --path ./archives

Operational notes

Resolves relative paths against the current working directory and persists an absolute path. Does not create or probe the directory. Local filesystem storage is the currently supported destination.

Output, placeholders & global flags
View exact CLI help
HELP OUTPUT
Configure a local directory; relative paths resolve against the current directory

Usage: coldctl destination add local [OPTIONS] --name <NAME> --path <PATH>

Options:
      --data-dir <PATH>  Override the OS application data directory
      --name <NAME>      Unique local name (ASCII letters, digits, hyphens, underscores)
      --output <OUTPUT>  [default: table] [possible values: table, json]
      --path <PATH>      Archive directory. Saved as an absolute path; created by destination test if missing
  -h, --help             Print help