Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.44.0.
bregctl history erase command reference
Erase retained history for one record using an owner-only JSON request file.
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 history erase [OPTIONS] --runtime-config <ABSOLUTE_FILE> --request-file <ABSOLUTE_FILE>Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Runtime configuration file. A symbolic link at any component of this path is refused. |
--request-file <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Absolute owner-only JSON erasure request file. Read through the parent directory this path resolves to, so a .. component is refused. The file must carry no group or other permission bits, because it names the records the erasure covers. A symbolic link at any component of this path is refused. |
--acknowledge-irreversible | No | n/a | n/a | n/a | Acknowledge that erasure cannot be undone. Without this flag the command is refused before any file is read or any database connection is opened. |
--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 (see a summary with ‘-h’) |
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.