Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.15.2.
Compile and validate an authoring project.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree. Hidden implementation commands are omitted.
relayctl check [OPTIONS] <PROJECT>Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<PROJECT> | Yes | n/a | n/a | n/a | Authoring project directory |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--production | No | n/a | n/a | n/a | Require all generated suggestions to have been reviewed |
--json | No | n/a | n/a | n/a | Emit the shared report as best-effort JSON for local automation |
-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.