Registry stack documentation: machine-readable Markdown.
Index of all pages: https://docs.registrystack.org/dev/llms.txt
Full corpus: https://docs.registrystack.org/dev/llms-full.txt

# bregctl data runs cancel command reference

> Generated syntax and options for bregctl data runs cancel.

{/* Generated from crates/registry-cli-docs/catalog.json and the workspace version in Cargo.toml by scripts/generate-cli-reference.mjs. Run npm run generate. */}

Cancel one caller-owned run while retaining its committed rows and receipts.

## Contract status

This page is generated from the public Clap command tree for Registry Stack source version `0.45.0` and catalog SHA-256 `18546dbdf436972522108829ab0f8c804142a7474cfe3841e0b8ff10e061c842`. Hidden implementation commands are omitted.

## Usage

```text
bregctl data runs cancel [OPTIONS] --breg-url <URL> --access-token-file <ABSOLUTE_FILE> --record-route <API_ROUTE> --profile <ID> --run-id <UUID>
```

## Options

| Option | Always required | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- |
| `--breg-url <URL>` | Yes | n/a | n/a | n/a | Base Registry Engine base URL. HTTP is accepted only for loopback hosts |
| `--access-token-file <ABSOLUTE_FILE>` | Yes | n/a | n/a | n/a | Absolute file containing one bearer access token and no other credential material. A symbolic link at any component of this path is refused. |
| `--record-route <API_ROUTE>` | Yes | n/a | n/a | n/a | Authored API route of the Record type, for example `households` |
| `--profile <ID>` | Yes | n/a | n/a | n/a | Access profile that owns the run context |
| `--run-id <UUID>` | Yes | n/a | n/a | n/a | Canonical run UUID shown by `bregctl data runs list` |
| `--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

After changing a public command, argument, option, default, environment binding, or help description, run `cargo run --locked -p registry-cli-docs -- --write`, commit `crates/registry-cli-docs/catalog.json`, then run `npm run generate` from `docs/site`.