Usage

Diff two schema files

driftabot <command> --base <file> --head <file> [--format <format>] [--fail-on-breaking]

Command	Description
openapi	Diff two OpenAPI 3.x schemas (YAML or JSON)
graphql	Diff two GraphQL SDL schemas
grpc	Diff two Protobuf schemas (.proto)

Flags

Flag	Description	Default
--base	Path to the base (before) schema file	required
--head	Path to the head (after) schema file	required
-f, --format	Output format: text, json, markdown, github	text
--fail-on-breaking	Exit with code 1 if breaking changes are detected	false

Examples

# OpenAPI — text output
driftabot openapi --base api/base.yaml --head api/head.yaml

# GraphQL — JSON output
driftabot graphql --base schema/base.graphql --head schema/head.graphql --format json

# gRPC — fail CI on breaking changes
driftabot grpc --base proto/base.proto --head proto/head.proto --fail-on-breaking

Impact analysis

After detecting breaking changes, use driftabot impact to scan source code and find every file and line that references each breaking change.

driftabot <schema-command> --base <file> --head <file> --format json \
  | driftabot impact --scan <dir>

Or from a saved diff file:

driftabot openapi --base base.yaml --head head.yaml --format json > diff.json
driftabot impact --diff diff.json --scan ./src

Flags

Flag	Description	Default
--diff	Path to a JSON diff file; omit or use - to read stdin	stdin
--scan	Directory to scan for source references	.
-f, --format	Output format: text, json, markdown, github	text

Examples

# Pipe OpenAPI diff directly into impact scan
driftabot openapi --base old.yaml --head new.yaml --format json \
  | driftabot impact --scan ./services

# Markdown report — collapsible sections per breaking change
driftabot impact --diff diff.json --scan ./src --format markdown

# JSON output (machine-readable)
driftabot impact --diff diff.json --scan ./src --format json

See Output Formats for format details and examples.