bregctl project planner-test command reference
Test a Rhai request planner or action handler 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.34.0 and catalog SHA-256 521175a69262e60df96745886392348e5bb8d82e63cdd24bdf4baa80d46e5ff4. Hidden implementation commands are omitted.
bregctl project planner-test [OPTIONS] <--entity <ENTITY>|--action <ACTION>> <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | Exactly one of --entity <ENTITY>, --action <ACTION> is required. |
--entity <ENTITY> is present | --request <JSON_FILE> is required. |
--request <JSON_FILE> is present | --entity <ENTITY> is required. |
--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. |
| Command invocation | --action <ACTION> and --entity <ENTITY> cannot be used together. |
| Command invocation | --action <ACTION> and --request <JSON_FILE> cannot be used together. |
| Command invocation | --entity <ENTITY> and --expect <JSON_FILE> cannot be used together. |
| Command invocation | --entity <ENTITY> and --input <JSON_FILE> cannot be used together. |
| Command invocation | --expect <JSON_FILE> and --request <JSON_FILE> cannot be used together. |
| Command invocation | --input <JSON_FILE> and --request <JSON_FILE> cannot be used together. |
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 |
|---|---|---|---|---|---|
--entity <ENTITY> | No | n/a | n/a | n/a | Compiled change-request entity whose Rhai planner will run; pair with —request |
--request <JSON_FILE> | No | n/a | n/a | n/a | Bounded strict JSON object containing synthetic request fields; requires —entity. A symbolic link at any component of this path is refused. |
--action <ACTION> | No | n/a | n/a | n/a | Compiled immediate action whose Rhai handler 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”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.