Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.26.1.
bregctl audit export command reference
Export the verified audit journal as JSON Lines in chain order.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.30.0 and catalog SHA-256 2221f17eae216048d4cfaf7f66e3dcd68a250f6f6de4e24b177441819192b475. Hidden implementation commands are omitted.
bregctl audit export [OPTIONS] --runtime-config <ABSOLUTE_FILE> --output <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. |
--output <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Absolute JSON Lines file the export creates. The export creates this file and never truncates, replaces, or appends to an existing one, so a destination that already exists is refused. A path holding a .. component is refused. A symbolic link at any component of this path is refused. |
--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.