Released docs. You are viewing the documentation published with v0.46.0. Development docs are available at Latest.
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.46.0 and catalog SHA-256 d43b1bf418e0b00fac52311fa3a106fa124512dbc88cf511475713af2d73aa47. 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.
Cookies on Registry Stack
We use optional cookies to understand how you use the main Registry Stack website and this documentation. If you contact us, we may link this activity to your enquiry. You can change your choice at any time. Read the privacy policy.
Your browser asks sites not to track you, so optional tracking stays off.
We could not use or save that choice. Optional tracking remains off.