Quickstart

Goal

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

Install

Run the following command to install the Mortar CLI globally on your system:

curl -sSL https://get.mortar.systems | sh

Authenticate

Before running checks, link your environment to your organization:

# Replace with your organization's license key
export MORTAR_LICENSE_TOKEN="MORTAR-XXXX-XXXX"

Run a score

Compare a proposed OpenAPI change against your production baseline:

mortar score \
--base examples/openapi/v1.yaml \
--head examples/openapi/v2_breaking.yaml \
--policy mortar.policy.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