Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.46.0.
evidencectl doctor command reference
Check one runtime configuration and its startup dependencies.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.46.1 and catalog SHA-256 61bebbb88fe15e4da92e2b0adbca0cd5b1a47b8eac38f4b91a15095011368a43. Hidden implementation commands are omitted.
evidencectl doctor [OPTIONS]Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--require-audit-under <ABSOLUTE_DIRECTORY> is present | --runtime-config <ABSOLUTE_FILE> is required. |
--without-audit-lock is present | --runtime-config <ABSOLUTE_FILE> is required. |
| Command invocation | --format <FORMAT> and --json cannot be used together. |
| Command invocation | --json and --runtime-config <ABSOLUTE_FILE> cannot be used together. |
| Command invocation | --project <PROJECT> and --runtime-config <ABSOLUTE_FILE> cannot be used together. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <ABSOLUTE_FILE> | No | n/a | n/a | n/a | Runtime configuration file |
--require-audit-under <ABSOLUTE_DIRECTORY> | No | n/a | n/a | n/a | Also prove that the audit destination resolves below this persistent root |
--without-audit-lock | No | n/a | n/a | n/a | Prove the audit destination without taking its single-writer lock. For a candidate staged beside the running instance it will replace, which holds that lock. Modes, write access, and a complete final entry are still proved, and every other dependency is proved as without it. |
--project <PROJECT> | No | n/a | n/a | n/a | Evidence project directory; defaults to the current directory. Compatibility form for inspecting a deployment project that holds runtime.yaml beside bundle/. New dependency checks use —runtime-config. |
--json | No | n/a | n/a | n/a | Compatibility spelling for JSON artifact-inspection output |
--format <FORMAT> | No | human | human, json, junit | n/a | Emit the selected command’s report in this format. junit is accepted only by test and fixtures run |
-h, --help | No | n/a | n/a | n/a | Print help (see a summary with ‘-h’) |
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.