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

# bregctl examples run command reference

> Generated syntax and options for bregctl examples run.

{/* Generated from Clap command definitions by scripts/generate-cli-reference.mjs. Run npm run generate. */}

Run or resume an example against the project's ready owned development instance.

## 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.

## Usage

```text
bregctl examples run [OPTIONS] <SCENARIO> [PROJECT]
```

## Constraints

| Condition | Requirement |
| --- | --- |
| Command invocation | `--attempt <ATTEMPT>` and `--new-attempt` cannot be used together. |

## Arguments

| Argument | Always required | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- |
| `<SCENARIO>` | Yes | n/a | n/a | n/a | Bounded scenario identifier declared in this project's examples catalogue |
| `[PROJECT]` | No | `.` | n/a | n/a | Authored project whose owned local development instance is ready. A symbolic link at any component of this path is refused. |

## Options

| Option | Always required | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- |
| `--input <INPUT>` | No | n/a | n/a | n/a | Editable JSON input (default: the scenario's declared examples input file) |
| `--attempt <ATTEMPT>` | No | n/a | n/a | n/a | Resume exactly this retained execution attempt |
| `--new-attempt` | No | n/a | n/a | n/a | Start a distinct attempt, with new idempotency keys and ordinary uniqueness checks |
| `--from-attempt <FROM_ATTEMPT>` | No | n/a | n/a | n/a | Completed population attempt whose typed captures this scenario uses |
| `--step <STEP>` | No | n/a | `submit`, `inspect`, `apply`, `history` | n/a | Advance one explicit source-owned request step. External review is completed separately |
| `--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

Run `npm run generate` from `docs/site` after changing a public command, argument, option, default, environment binding, or help description.