apiome verify
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome verify
Run executable contract verification and emit CI artifacts.
apiome verify [OPTIONS] COMMAND [ARGS]...
Subcommands: contract.
apiome verify contract
Execute a contract suite against a target (POST …/contracts/{ref}/run).
Prints a summary with the evidence run id and per-case failures. Writes JSON or JUnit via the export endpoint when --out / --format ask for an artifact. Exits non-zero when the stored outcome is not passed, or when the suite cannot run (ok: false).
apiome verify contract [OPTIONS]
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--project | text | yes | Project slug or UUID (or Catalog item slug/UUID with --kind catalog). | |
--version | text | yes | Version label, revision UUID, or 'latest'. | |
--target | text | yes | Verification target slug or id. Credentials come from the target's env/stored reference on the server — never from this flag. | |
--kind | text | project | Which surface the artifact lives on: project (default) or catalog. | |
--format | text | json | CI artifact format: json (default) or junit. | |
--out | path | Write the export artifact to this file (JSON or JUnit XML). | ||
--seed | integer range | 0 | Seed for generated values. The same version and seed give the same suite. | |
--examples / --no-examples | flag | --examples | Compile the examples declared in the source document (on by default). | |
--generated / --no-generated | flag | --generated | Compile schema-valid generated bodies (on by default). | |
--negative / --no-negative | flag | --negative | Compile the negative cases a contract needs to be worth running (on by default). | |
--operation | text (repeatable) | Restrict to this operation key (repeatable), e.g. 'GET /pets/{petId}'. | ||
--max-operations | integer range | Cap on compiled operations. Truncation is reported as a finding. | ||
--idempotency-key | text | Evidence upload retry key; a repeated key returns the original run. | ||
--context | text (repeatable) | Non-secret CI context as KEY=VALUE (repeatable), e.g. commit=abc123. |