Released docs. You are viewing the documentation published with v0.34.0. Development docs are available at Latest.
evidencectl source mock serve command reference
Serve schema-valid synthetic responses from OpenAPI or exact edited cases.
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 521175a69262e60df96745886392348e5bb8d82e63cdd24bdf4baa80d46e5ff4. Hidden implementation commands are omitted.
evidencectl source mock serve [OPTIONS]Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | --as-of <AS_OF> and --config <CONFIG> cannot be used together. |
| Command invocation | --config <CONFIG> and --explain cannot be used together. |
| Command invocation | --config <CONFIG> and --openapi <OPENAPI> cannot be used together. |
| Command invocation | --config <CONFIG> and --operation <OPERATION> cannot be used together. |
| Command invocation | --config <CONFIG> and --project <PROJECT> cannot be used together. |
| Command invocation | --config <CONFIG> and --seed <SEED> cannot be used together. |
| Command invocation | --openapi <OPENAPI> and --project <PROJECT> cannot be used together. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--openapi <OPENAPI> | No | n/a | n/a | n/a | OpenAPI 3.0 or 3.1 document for an ephemeral, write-free preview |
--config <CONFIG> | No | n/a | n/a | n/a | Materialized mock configuration whose checked body bytes are authoritative |
--project <PROJECT> | No | n/a | n/a | n/a | Evidence project directory; defaults to the current directory. This command needs an editable project: one holding questions/ and sources/ beside evidence-project.yaml. |
--operation <OPERATION> | No | n/a | n/a | n/a | Narrow ephemeral discovery to one METHOD /path/template operation |
--http-addr <HTTP_ADDR> | No | n/a | n/a | n/a | Numeric loopback listener address. Standalone mode defaults to 127.0.0.1:4010 |
--seed <SEED> | No | n/a | n/a | n/a | Deterministic unsigned generation seed. Ephemeral mode defaults to zero |
--as-of <AS_OF> | No | n/a | n/a | n/a | Calendar date used only by explicit or inferred age generation |
--explain | No | n/a | n/a | n/a | Explain generator choices without printing generated or authored values |
--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.