CLI Reference
The full --help output for every rite command, reproduced verbatim. For
explanations and examples, see the Rite CLI guide.
Exit codes
0 Success
1 A negative result or bad input (invalid ceremony, failed verification)
2 A usage error, or an unexpected internal faultrite check
Validate a ceremony definition without running it
Resolves the ceremony and reports diagnostics (missing references, undefined roles, schema errors, actions unsupported by this build), or a summary of what it contains.
Usage: rite check [OPTIONS] <FILE>
Arguments:
<FILE>
Path to the ceremony YAML file
Options:
--param <NAME=VALUE>
Set a ceremony parameter
--role <ROLE_ID=PERSON>
Assign a person to a role
--material <NAME=PATH_OR_ID>
Provide a material source
Use `NAME=@PATH` for a file on disk, or `NAME=IDENTIFIER` for a pre-provisioned material.
-h, --help
Print help (see a summary with '-h')
Environment variables:
RITE_PARAM_<NAME> Set a ceremony parameter (like --param)
RITE_ROLE_<ROLE_ID> Assign a person to a role (like --role)
RITE_MATERIAL_<NAME> Provide a material source (like --material)
The name after the prefix is case-insensitive (RITE_ROLE_CRYPTO_OFFICER and
RITE_ROLE_crypto_officer are equivalent).
A command-line flag takes precedence over the matching variable.rite script
Render a ceremony as a printable protocol
Produces a self-contained HTML document that participants follow and complete by hand during the ceremony.
Usage: rite script [OPTIONS] <FILE>
Arguments:
<FILE>
Path to the ceremony YAML file
Options:
-o, --output <OUTPUT>
Output path (`-` for stdout)
Defaults to the ceremony file name with the document extension, next to the source.
--theme <THEME>
Document theme
Possible values:
- formal: Formal serif "ceremony protocol" look
[default: formal]
--brand-name <NAME>
Organization name in the header
--logo <PATH>
Logo image for the header
--accent <COLOR>
Accent color (hex, e.g. `#1f3a5f`)
--param <NAME=VALUE>
Set a ceremony parameter
--role <ROLE_ID=PERSON>
Assign a person to a role
--material <NAME=PATH_OR_ID>
Provide a material source
Use `NAME=@PATH` for a file on disk, or `NAME=IDENTIFIER` for a pre-provisioned material.
-h, --help
Print help (see a summary with '-h')
Environment variables:
RITE_PARAM_<NAME> Set a ceremony parameter (like --param)
RITE_ROLE_<ROLE_ID> Assign a person to a role (like --role)
RITE_MATERIAL_<NAME> Provide a material source (like --material)
The name after the prefix is case-insensitive (RITE_ROLE_CRYPTO_OFFICER and
RITE_ROLE_crypto_officer are equivalent).
A command-line flag takes precedence over the matching variable.rite run
Run a ceremony and record its transcript
Walks the operator and witnesses through each step, performs the machine-verifiable actions, and writes a timestamped output directory with the artifacts and an append-only transcript.
Usage: rite run [OPTIONS] <FILE>
Arguments:
<FILE>
Path to the ceremony YAML file
Options:
--param <NAME=VALUE>
Set a ceremony parameter
--role <ROLE_ID=PERSON>
Assign a person to a role
--material <NAME=PATH_OR_ID>
Provide a material source
Use `NAME=@PATH` for a file on disk, or `NAME=IDENTIFIER` for a pre-provisioned material.
--no-prompt
Do not prompt for missing parameters
--dry-run
Simulate without performing real operations
-o, --output <OUTPUT>
Output directory (default: current directory)
--no-transcript
Do not write a transcript
--frontend <FRONTEND>
Frontend driver (auto-detected when omitted)
When omitted, `tui` is used if stdout is a TTY and the `tui` feature is built in, otherwise `console`.
Possible values:
- tui: Interactive terminal UI (TEA-style). Default when stdout is a TTY
- console: Plain stdin/stdout driver. Reference implementation of the protocol
- headless: Auto-answering driver for CI / smoke tests
-h, --help
Print help (see a summary with '-h')
Environment variables:
RITE_PARAM_<NAME> Set a ceremony parameter (like --param)
RITE_ROLE_<ROLE_ID> Assign a person to a role (like --role)
RITE_MATERIAL_<NAME> Provide a material source (like --material)
The name after the prefix is case-insensitive (RITE_ROLE_CRYPTO_OFFICER and
RITE_ROLE_crypto_officer are equivalent).
A command-line flag takes precedence over the matching variable.rite verify
Verify a ceremony transcript's integrity
Re-checks the append-only hash chain, re-derives the recorded entropy, and, for a run directory, re-hashes the artifacts against their recorded digests.
Usage: rite verify [OPTIONS] <FILE>
Arguments:
<FILE>
Transcript file or run output directory
Options:
--allow-truncated
Accept a transcript with no terminal fact (an interrupted run)
By default a truncated transcript fails verification: cutting it at a line boundary leaves the hash chain intact, so truncation must be opted into.
-h, --help
Print help (see a summary with '-h')rite report
Render a post-ceremony report from a transcript
Produces a self-contained HTML report of a completed run, for stakeholders and auditors.
Usage: rite report [OPTIONS] <TRANSCRIPT>
Arguments:
<TRANSCRIPT>
Transcript file or run output directory
Accepts a `transcript.jsonl` file or the output directory produced by `rite run` (which contains `transcript.jsonl`).
Options:
-o, --output <OUTPUT>
Output path (`-` for stdout)
Defaults to `report.html` next to the transcript.
--theme <THEME>
Document theme
Possible values:
- formal: Formal serif "ceremony protocol" look
[default: formal]
--brand-name <NAME>
Organization name in the header
--logo <PATH>
Logo image for the header
--accent <COLOR>
Accent color (hex, e.g. `#1f3a5f`)
-h, --help
Print help (see a summary with '-h')rite completions
Print a shell completion script
Usage: rite completions <SHELL>
Arguments:
<SHELL> Shell to generate completions for [possible values: bash, elvish, fish, powershell, zsh]
Options:
-h, --help Print helprite version
Print version and build information
Usage: rite version [OPTIONS]
Options:
--verbose Print build and environment details
-h, --help Print help