Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.43.0.
bregctl project action-test command reference
Test a named Action plan function with bounded synthetic JSON.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.44.0 and catalog SHA-256 1577fc2512d840ed27fdd70f4b3829f9f7796ab1a3a9a426c283904b3bf1a885. Hidden implementation commands are omitted.
bregctl project action-test [OPTIONS] --input <JSON_FILE> --action <ACTION> <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--action <ACTION> is present | --input <JSON_FILE> is required. |
--input <JSON_FILE> is present | --action <ACTION> is required. |
--expect <JSON_FILE> is present | All of --input <JSON_FILE>, --action <ACTION> are required. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<PROJECT> | Yes | n/a | n/a | n/a | Base Registry Engine project directory. A symbolic link at any component of this path is refused. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--action <ACTION> | Yes | n/a | n/a | n/a | Compiled Action whose named plan function will run; pair with —input |
--input <JSON_FILE> | No | n/a | n/a | n/a | Bounded strict JSON object using authored action input IDs, without an HTTP envelope; requires —action. A symbolic link at any component of this path is refused. |
--expect <JSON_FILE> | No | n/a | n/a | n/a | With —action and —input, assert exact effects or refusal and optional ordered evidenceCalls mocks without printing values. 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 |
Generation contract
Section titled “Generation contract”After changing a public command, argument, option, default, environment binding, or help description, run cargo run --locked -p registry-cli-docs -- --write, commit crates/registry-cli-docs/catalog.json, then run npm run generate from docs/site.