evidencectl new command reference
Start an editable Evidence Gateway project from OpenAPI, a starter, or a SQLite extract.
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 new [OPTIONS] --profile <PROFILE> <--openapi <OPENAPI>|--transport <TRANSPORT>|--starter <STARTER>> <DIRECTORY>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | Exactly one of --openapi <OPENAPI>, --transport <TRANSPORT>, --starter <STARTER> is required. |
| Command invocation | --openapi <OPENAPI> and --starter <STARTER> cannot be used together. |
| Command invocation | --openapi <OPENAPI> and --transport <TRANSPORT> cannot be used together. |
| Command invocation | --starter <STARTER> and --transport <TRANSPORT> cannot be used together. |
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 |
--starter <STARTER> | No | n/a | n/a | n/a | Reviewed local starter directory to copy without requiring an API description |
--profile <PROFILE> | Yes | n/a | local | n/a | Explicit development profile for local authoring |
--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.