Released docs. You are viewing the documentation published with v0.46.0. Development docs are available at Latest.
evidencectl source mock generate command reference
Materialize or extend editable mock cases from OpenAPI.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.46.0 and catalog SHA-256 d43b1bf418e0b00fac52311fa3a106fa124512dbc88cf511475713af2d73aa47. Hidden implementation commands are omitted.
evidencectl source mock generate [OPTIONS] [PROJECT]Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--output <OUTPUT> is present | --openapi <OPENAPI> is required. |
--case <CASE> is present | --operation <OPERATION> is required. |
--path-parameter <PATH_PARAMETERS> is present | --operation <OPERATION> is required. |
| Command invocation | --as-of <AS_OF> and --config <CONFIG> cannot be used together. |
| Command invocation | --config <CONFIG> and --openapi <OPENAPI> cannot be used together. |
| Command invocation | --config <CONFIG> and --output <OUTPUT> cannot be used together. |
| Command invocation | --config <CONFIG> and --seed <SEED> cannot be used together. |
| Command invocation | --config <CONFIG> and [PROJECT] cannot be used together. |
| Command invocation | --openapi <OPENAPI> and [PROJECT] cannot be used together. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
[PROJECT] | No | n/a | n/a | n/a | Evidence project directory; defaults to the current directory. This command needs an editable project containing evidence.yaml and its named Function assets. |
Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--openapi <OPENAPI> | No | No | n/a | n/a | n/a | OpenAPI document for initial standalone materialization |
--config <CONFIG> | No | No | n/a | n/a | n/a | Existing editable configuration to complete or extend |
--output <OUTPUT> | No | No | n/a | n/a | n/a | Initial configuration path. Defaults to mocks/source.yaml |
--operation <OPERATION> | No | No | n/a | n/a | n/a | Select one METHOD /path/template operation |
--case <CASE> | No | No | n/a | n/a | n/a | Starter or appended case name for the selected operation |
--path-parameter <PATH_PARAMETERS> | No | Yes | n/a | n/a | n/a | Concrete selected-operation path parameter as NAME=VALUE; repeat as needed |
--seed <SEED> | No | No | n/a | n/a | n/a | Deterministic unsigned generation seed for a new plan. Defaults to zero |
--as-of <AS_OF> | No | No | n/a | n/a | n/a | Calendar date used only by explicit or inferred age generation |
--explain | No | No | n/a | n/a | n/a | Explain generator choices without printing generated or authored values |
--format <FORMAT> | No | No | human | human | n/a | Select human-readable output; this command provides no JSON report |
-h, --help | No | 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.