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.34.0 and catalog SHA-256 521175a69262e60df96745886392348e5bb8d82e63cdd24bdf4baa80d46e5ff4. 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 | Absolute Base Registry Engine 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”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.