bregctl examples run command reference
Run or resume an example against the project’s ready owned development instance.
Contract status
Section titled “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.
bregctl examples run [OPTIONS] <SCENARIO> [PROJECT]Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | --attempt <ATTEMPT> and --new-attempt cannot be used together. |
Arguments
Section titled “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
Section titled “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 |
--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”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.