apiome checks

Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.

apiome checks

Run and read the API change check suite (one verdict for a pull request).

apiome checks [OPTIONS] COMMAND [ARGS]...

Subcommands: run, show.

apiome checks run

Evaluate the API change check suite for a version (POST …/check-suite).

Re-running over unchanged inputs returns the same evaluation — the same evidence ids — and does not report to the provider again. Exit codes: 0 pass or skipped, 7 failed, 8 pending, 1 unreachable, 2 rejected (auth, unknown project/version/commit).

apiome checks run [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project slug or UUID.
--version	text		yes	Version label or revision UUID.
--commit	text			Commit to report against (e.g. $GITHUB_SHA). Defaults to the commit the draft is synchronized with; only a version bound to a repository ref takes one.
--pr	integer range			Pull request number the commit belongs to.
--publish / --no-publish	flag	--publish		Report the verdict on the pull request (on by default).
--format	text	text		Output: text (default), json (the API response), or md (the pull-request summary).

apiome checks show

Read an API change check suite evaluation without evaluating anything.

Exits with the evaluation's verdict, like checks run. A stale evaluation (the draft or the policy moved since) is reported on stderr — run the suite again for a current answer.

apiome checks show [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project slug or UUID.
--version	text			Version label or revision UUID (the latest evaluation of it).
--run	text			One evaluation by id — the drill-down a pull request links to.
--commit	text			Only the latest evaluation at this commit (with --version).
--format	text	text		Output: text (default), json (the API response), or md (the pull-request summary).