bregctl data import command reference
Import JSONL records through the ordinary authenticated batch 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 import [OPTIONS] --package <ABSOLUTE_DIRECTORY> --breg-url <URL> --access-token-file <ABSOLUTE_FILE> --entity <ID> --profile <ID> --operation <OPERATION> --input <FILE> --checkpoint <FILE>Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--package <ABSOLUTE_DIRECTORY> | Yes | 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 | 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 | 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 | n/a | n/a | n/a | Compiled entity identifier |
--profile <ID> | Yes | n/a | n/a | n/a | Compiled non-anonymous access profile identifier |
--operation <OPERATION> | Yes | n/a | create, patch | n/a | Import item operation |
--input <FILE> | Yes | n/a | n/a | n/a | JSON Lines import file. A symbolic link at any component of this path is refused. |
--checkpoint <FILE> | Yes | n/a | n/a | n/a | Import checkpoint file. A ctl-held .state sidecar is created beside it. A symbolic link at any component of this path is refused. |
--max-chunks <COUNT> | No | n/a | n/a | n/a | Stop after this many committed chunks, for resumable operator runs |
--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”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.