Released docs. You are viewing the documentation published with v0.46.0. Development docs are available at Latest.
Validate policy, closed context schemas and required provider capabilities offline.
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.
caseworkctl check [OPTIONS] <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--provider-id <PROVIDER_ID> is present | --against-breg-package <DIRECTORY> is required. |
--environment is present | --runtime-config <FILE> is required. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<PROJECT> | Yes | n/a | n/a | n/a | Existing authored Casework project directory |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--production | No | n/a | n/a | n/a | Check the exact package closure required for production |
--deny-warnings | No | n/a | n/a | n/a | Refuse authored warnings as well as errors |
--against-breg-package <DIRECTORY> | No | n/a | n/a | n/a | Compare imported provider contracts with this native Base Registry Engine (BReg) deployment package |
--provider-id <PROVIDER_ID> | No | n/a | n/a | n/a | Limit native package comparison to this declared provider |
--bregctl-bin <BINARY> | No | n/a | n/a | n/a | Matching bregctl executable used for native package verification; otherwise use the rstack-selected helper or bregctl on PATH |
--runtime-config <FILE> | No | n/a | n/a | n/a | Runtime configuration file |
--environment | No | n/a | n/a | n/a | Resolve configured environment substitutions while checking the runtime file |
--format <FORMAT> | No | human | human, json | n/a | Write human diagnostics and reports, or one typed JSON report |
-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.