Mortar logoMORTAR

Quickstart

Goal

In this quickstart you will install the Mortar CLI, score an OpenAPI change, and see Mortar block a breaking release.

Install

# macOS / Linux (example) # Replace with your actual installer once available. # For now: build from source. git clone <YOUR_REPO_URL> cd mortar make build ./bin/mortar --help

Run a score

./bin/mortar score --base examples/openapi/v1.yaml --head examples/openapi/v2_breaking.yaml

Expected output:

  • Insight: at least one BREAKING drift finding
  • Foresight: score below threshold
  • Authority: decision = BLOCK

Integrate in CI

Mortar is designed to be a release gate. See: /docs/integrations/ci

Next

  • Concepts → /docs/concepts
  • CLI Reference → /docs/cli
← Documentation
Concepts →