bregctl init command reference
Create an authoring project in a new directory: a domain-neutral example, one derived from an embedded reference model with --from, or a shipped starter with --template.
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 init [OPTIONS] <DESTINATION>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--selection <FILE> is present | --from <MODEL> is required. |
--starter <NAME> is present | --from <MODEL> is required. |
| Command invocation | --from <MODEL> and --template <ID> cannot be used together. |
| Command invocation | --selection <FILE> and --starter <NAME> cannot be used together. |
| Command invocation | --selection <FILE> and --template <ID> cannot be used together. |
| Command invocation | --starter <NAME> and --template <ID> cannot be used together. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<DESTINATION> | Yes | n/a | n/a | n/a | New directory that will receive the project closure. A symbolic link at any component of this path is refused. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--from <MODEL> | No | n/a | publicschema | n/a | Derive the project from an embedded reference model instead of writing the example. Without --selection or --starter, the command asks which concepts and properties to select at the terminal |
--selection <FILE> | No | n/a | n/a | n/a | A selection document naming the concepts and properties to derive; the written project echoes one under model/selection.yaml. A symbolic link at any component of this path is refused. |
--starter <NAME> | No | n/a | n/a | n/a | A selection shipped with the model, by name |
--template <ID> | No | n/a | professional-licences, agricultural-holdings, public-organizations, seed-lots | n/a | Write one of the shipped starter registry projects verbatim instead of the plain example or a project derived from --from |
--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.