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

coldctl jobs cancel

Request a cooperative stop.

ImplementedLocal state write

Syntax

USAGE
coldctl jobs cancel [OPTIONS] <ID>

Arguments & options

ArgumentDescription
<ID>Job UUID from coldctl jobs list.
OptionDescription / default
--data-dir <PATH>Override the OS application data directory
--output <OUTPUT>[default: table] [possible values: table, json]
-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 jobs cancel JOB_ID

Operational notes

Stops an active worker after its current batch is published and checkpointed. Files are retained. An idle interrupted or failed job is cancelled immediately; finalization can win a race. Resume or retry explicitly clears the cancellation request.

Output, placeholders & global flags
View exact CLI help
HELP OUTPUT
Request a safe stop after the current batch; published files are preserved

Usage: coldctl jobs cancel [OPTIONS] <ID>

Arguments:
  <ID>  

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