Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.44.0.
bregctl data runs list command reference
List the caller’s runs for one Record type API route and access profile.
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 data runs list [OPTIONS] --breg-url <URL> --access-token-file <ABSOLUTE_FILE> --record-route <API_ROUTE> --profile <ID>Options
Section titled “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 |
--status <STATUS> | No | n/a | open, complete, cancelled, blocked | n/a | Return only runs in this lifecycle state |
--input-digest <SHA256> | No | n/a | n/a | n/a | Return only runs announced with this whole-input SHA-256 digest |
--cursor <UUID> | No | n/a | n/a | n/a | Canonical run UUID returned as the previous page’s next cursor |
--limit <COUNT> | No | 25 | n/a | n/a | Maximum runs to return, from 1 to 100 |
--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.
Cookies on Registry Stack
We use optional cookies to understand how you use the main Registry Stack website and this documentation. If you contact us, we may link this activity to your enquiry. You can change your choice at any time. Read the privacy policy.
Your browser asks sites not to track you, so optional tracking stays off.
We could not use or save that choice. Optional tracking remains off.