Skip to main content

apiome compat

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

apiome compat​

Compare two OpenAPI revisions via independent oasdiff compatibility evidence.

apiome compat [OPTIONS] COMMAND [ARGS]...

Options

OptionTypeDefaultRequiredDescription
--projecttextyesProject UUID or slug.
--versiontextyesHead / candidate version (UUID, slug, or label).
--base-versiontextyesBaseline version (UUID, slug, or label) to compare against.
--formattextjsonGate output format: json (default), sarif, or junit.
--fail-ontextbreakingExit non-zero when findings at this level or higher are present: breaking (default), dangerous, or info.