Released docs. You are viewing the documentation published with v0.46.0. Development docs are available at Latest.
Create a new editable Evidence project.
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 init [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 <FORMAT> | No | human | human, json, junit | n/a | Emit the selected command’s report in this format. junit is accepted only by test and fixtures run |
-h, --help | 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.