evidencectl source suggest command reference
Suggest source configuration from an OpenAPI document.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.38.0 and catalog SHA-256 cd13c658f65af295f9df3c6db86dc045ac06e9e040afc1f5f5b27c3184ab653d. Hidden implementation commands are omitted.
evidencectl source suggest [OPTIONS] <--openapi <OPENAPI>|PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | Exactly one of --openapi <OPENAPI>, [PROJECT] is required. |
--list-pointers is present | --operation <OPERATION> is required. |
| 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; the draft is printed when this is absent. This command needs an editable project: one holding questions/ and sources/ beside evidence-project.yaml. |
Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--openapi <OPENAPI> | No | No | n/a | n/a | n/a | OpenAPI 3.0 or 3.1 document for a print-only draft. With a project, the retained source.openapi.yaml is used instead |
--operation <OPERATION> | No | No | n/a | n/a | n/a | Operation as “METHOD /path/template”; interactive selection if absent |
--status <STATUS> | No | No | 200 | n/a | n/a | Response status code to read the schema from |
--media-type <MEDIA_TYPE> | No | No | application/json | n/a | n/a | Response media type to read the schema from |
--select <SELECTION> | No | Yes | n/a | n/a | n/a | Projection pointer to select; repeat once per leaf. Interactive selection if absent |
--list-pointers | No | No | n/a | n/a | n/a | Print the candidate pointers the selected operation and response offer for —select, then stop without drafting |
--sample <SAMPLE> | No | No | n/a | n/a | n/a | Sample response JSON file used to suggest bounds. Read only; nothing from it is copied into any artifact except derived bounds |
--source-id <SOURCE_ID> | No | No | n/a | n/a | n/a | Source identifier for the generated artifacts |
--base-url <BASE_URL> | No | No | n/a | n/a | n/a | Reviewed source origin to write into a newly created source draft |
--format <output_format> | No | No | human | human, json, junit | n/a | Select human-readable or machine-readable output. junit is accepted only by fixture runs (test and fixtures run) |
-h, --help | No | 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.