caseworkctl retention erase command reference
Preview or erase retained local payload copies for one exact source request.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.34.0 and catalog SHA-256 521175a69262e60df96745886392348e5bb8d82e63cdd24bdf4baa80d46e5ff4. Hidden implementation commands are omitted.
caseworkctl retention erase [OPTIONS] --source-id <SOURCE_ID> --request-kind <REQUEST_KIND> --request-id <REQUEST_ID> <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 |
--source-id <SOURCE_ID> | Yes | n/a | n/a | n/a | Stable Casework source identifier |
--request-kind <REQUEST_KIND> | Yes | n/a | n/a | n/a | Source-owned request kind |
--request-id <REQUEST_ID> | Yes | n/a | n/a | n/a | Source-owned request identifier |
--apply | No | n/a | n/a | n/a | Apply the reviewed local erasure. 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 |
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.