bregctl check command reference

Validate a Base Registry Engine authoring project without opening a database.

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.

Usage

bregctl check [OPTIONS] <PROJECT|--package <DIRECTORY>>

Constraints

Condition	Requirement
Command invocation	Exactly one of [PROJECT], --package <DIRECTORY> is required.
Command invocation	--deny-findings and --package <DIRECTORY> cannot be used together.
Command invocation	--package <DIRECTORY> and --production cannot be used together.
Command invocation	--package <DIRECTORY> and [PROJECT] cannot be used together.

Arguments

Argument	Always required	Default	Values	Environment	Description
[PROJECT]	No	n/a	n/a	n/a	Base Registry Engine project directory. A symbolic link at any component of this path is refused.

Options

Option	Always required	Default	Values	Environment	Description
--package <DIRECTORY>	No	n/a	n/a	n/a	Closed package to verify against its sums, reporting the registry revision it rederives. A symbolic link at any component of this path is refused.
--production	No	n/a	n/a	n/a	Enforce production-only package closure requirements
--deny-findings	No	n/a	n/a	n/a	Exit unsuccessfully when any authoring finding needs review, including access warnings
--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

Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.