evidencectl new command reference
Start an editable Evidence Gateway project from OpenAPI or a SQLite extract.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree. Hidden implementation commands are omitted.
evidencectl new --profile <PROFILE> <--openapi <OPENAPI>|--transport <TRANSPORT>> <DIRECTORY>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | Exactly one of --openapi <OPENAPI>, --transport <TRANSPORT> is required. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<DIRECTORY> | Yes | n/a | n/a | n/a | New directory to create for the editable authoring project |
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: a local path or an HTTPS URL |
--transport <TRANSPORT> | No | n/a | sqlite-extract | n/a | Source transport to author without an API description |
--profile <PROFILE> | Yes | n/a | local | n/a | Explicit development profile for local authoring |
-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.