Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.15.2.
Relay V2 project authoring, validation, and packaging.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree. Hidden implementation commands are omitted.
relayctl [OPTIONS] <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
init | Initialize a complete authoring project with unreviewed starters |
inspect | Inspect SQLite structure without reading row values |
check | Compile and validate an authoring project |
generate | Generate deterministic artifacts from the compiled project |
test | Run the project’s offline fixture cases through the shared kernel |
diff | Classify meaning, disclosure, and security changes between projects |
package | Build a deterministic sealed deployment package |
tooling | Advanced editor and language-server integration surfaces |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--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 |
-V, --version | No | n/a | n/a | n/a | Print version |
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.