bregctl data export command reference
Export records through the ordinary authenticated list API.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.38.0 and catalog SHA-256 cd13c658f65af295f9df3c6db86dc045ac06e9e040afc1f5f5b27c3184ab653d. Hidden implementation commands are omitted.
bregctl data export [OPTIONS] --package <ABSOLUTE_DIRECTORY> --breg-url <URL> --access-token-file <ABSOLUTE_FILE> --entity <ID> --profile <ID> --field <ID> --output <FILE> --checkpoint <FILE>Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--package <ABSOLUTE_DIRECTORY> | Yes | No | n/a | n/a | n/a | Absolute closed package directory used only for deterministic planning. A symbolic link at any component of this path is refused. |
--breg-url <URL> | Yes | No | n/a | n/a | n/a | Base Registry Engine base URL. HTTP is accepted only for loopback hosts |
--access-token-file <ABSOLUTE_FILE> | Yes | No | n/a | n/a | n/a | File containing one bearer access token and no other credential material. A symbolic link at any component of this path is refused. |
--entity <ID> | Yes | No | n/a | n/a | n/a | Compiled entity identifier |
--profile <ID> | Yes | No | n/a | n/a | n/a | Compiled non-anonymous export-enabled access profile identifier |
--field <ID> | Yes | Yes | n/a | n/a | n/a | Requested readable field. Repeat for every exported field |
--output <FILE> | Yes | No | n/a | n/a | n/a | JSON Lines output file. Existing output resumes from its checkpoint. A resume continues after the last page the checkpoint records and discards the output beyond it, which is at most the one page a run stopped between appending a page and publishing its checkpoint left behind. A longer tail is refused rather than discarded. The output and the checkpoint are usable only as a pair: one present without the other is refused, and removing the file that remains starts a fresh export. A path holding a .. component is refused. A symbolic link at any component of this path is refused. |
--checkpoint <FILE> | Yes | No | n/a | n/a | n/a | Export checkpoint file written after every page. The checkpoint is published after the page it records reaches the output, so it names the position a resume continues from. Keep it for as long as the output it belongs to, and give each export its own pair. A path holding a .. component is refused. A symbolic link at any component of this path is refused. |
--max-pages <COUNT> | No | No | n/a | n/a | n/a | Stop after this many pages, for bounded operator runs |
--format <FORMAT> | No | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | No | 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.