caseworkctl attempt settle command reference
Preview or record an operator settlement of one uncertain source attempt.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.30.0 and catalog SHA-256 2221f17eae216048d4cfaf7f66e3dcd68a250f6f6de4e24b177441819192b475. Hidden implementation commands are omitted.
Description
Section titled “Description”Preview or record an operator settlement of one uncertain source attempt. Only an uncertain attempt whose execution lease has expired can be settled. Apply changes the attempt and its work item and records the decision in the work item’s history in one transaction.
caseworkctl attempt settle [OPTIONS] --attempt-id <UUID> --outcome <OUTCOME> --reason <REASON> --decided-by <DECIDED_BY> <PROJECT>Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<PROJECT> | Yes | n/a | n/a | n/a | Authored Casework project directory |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <FILE> | No | n/a | n/a | n/a | Runtime configuration file; defaults to runtime.yaml in the project |
--attempt-id <UUID> | Yes | n/a | n/a | n/a | Uncertain source attempt to settle |
--outcome <OUTCOME> | Yes | n/a | applied, not-applied | n/a | What the source owner confirmed about the attempt |
--reason <REASON> | Yes | n/a | n/a | n/a | Why the attempt is settled this way; recorded in the work item’s history |
--decided-by <DECIDED_BY> | Yes | n/a | n/a | n/a | Who made the decision; recorded in the work item’s history |
--apply | No | n/a | n/a | n/a | Apply the reviewed settlement. Omit to preview |
--format <FORMAT> | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | No | n/a | n/a | n/a | Print help (see a summary with ‘-h’) |
Generation contract
Section titled “Generation contract”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.