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.34.0 and catalog SHA-256 c9eb944fbb64b3beca0250dc0dee945ea12d5c5f92ffeab2f7c21d9eeb888c6c. Hidden implementation commands are omitted.
evidencectl doctor [OPTIONS]Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--require-audit-under <ABSOLUTE_DIRECTORY> is present | --runtime-config <FILE> is required. |
| Command invocation | --format <output_format> and --json cannot be used together. |
| Command invocation | --json and --runtime-config <FILE> cannot be used together. |
| Command invocation | --project <PROJECT> and --runtime-config <FILE> cannot be used together. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <FILE> | No | n/a | n/a | n/a | Absolute Evidence Gateway runtime configuration file to inspect |
--require-audit-under <ABSOLUTE_DIRECTORY> | No | n/a | n/a | n/a | Also prove that the audit destination resolves below this persistent root |
--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 <output_format> | No | human | human, json | n/a | Select human-readable or machine-readable output |
-h, --help | No | n/a | n/a | n/a | Print help (see a summary with ‘-h’) |
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.