Documentation Platform

Guides, references, and recipes for integrating DRIFT into your workflow — from first install to enterprise-grade policies.

Search documentation, CLI reference, and guides...
PlatformOverview

Platform Overview

DRIFT is a Contract-Aware API Regression Sentinel designed to compare OpenAPI specifications, replay production traffic against candidate contracts, classify compatibility changes, and block breaking mutations in CI/CD pipelines.

Core Philosophy
DRIFT combines AST structural parsing with eBPF shadow traffic replay. While static OpenAPI diff tools catch syntax changes, DRIFT measures the runtime impact on actual client workloads.

Quick Start Commands

terminal
# Install the DRIFT CLI
npm install -g @drift/cli

# Initialize in your repo
drift init --contract openapi.yaml

# Run a local diff check
drift check

# Add to GitHub Actions
drift ci --provider github

Pro tip

Run drift check --watch during local development to get instant feedback as you edit your contract.

GitHub Actions Integration

.github/workflows/drift.yml
# .github/workflows/drift.yml
name: DRIFT
on: pull_request
jobs:
  drift:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: drift/setup-action@v1
      - run: drift check --gate breaking

Installation & Setup

Install the DRIFT CLI globally via npm or Docker binary.

npm install -g @drift/cli
CLI v1.4.2
Command: drift compare

DRIFT CLI Reference Specification

The drift compare command parses OpenAPI contracts, calculates structural AST deltas, replays shadow traffic, and emits compatibility signals.

Command Usage

terminal-command.sh
bash
# CLI Command Syntax
drift compare --baseline=<file> --candidate=<file> [options]

# Example Invocation
drift compare \
  --baseline=./specs/v1.2.0.json \
  --candidate=./specs/v1.3.0.json \
  --traffic-corpus=./corpus/ebpf-prod.json \
  --format=html \
  --out=./reports/drift-report.html

Supported Command Options

Flag / OptionTypeDescription
--baselinestring (required)Path to baseline OpenAPI 3.x JSON or YAML specification.
--candidatestring (required)Path to candidate target OpenAPI specification.
--traffic-corpusstring (optional)Path to eBPF recorded shadow traffic JSON corpus.
--formatconsole | json | htmlOutput format for generated compatibility report. Default: console.

6-Stage Execution Pipeline

DRIFT evaluates contracts through 6 deterministic stages: Spec Ingestion, AST Diff, Traffic Ingestion, Shadow Replay, Severity Classification, and Multi-Format Reporting.

Interactive Documentation Playground

Test simulated contract comparisons directly inside the documentation portal.

Structural AST Diff Matrix
+1 Added-0 Removed~0 Modified
1
{ "openapi": "3.1.0",
2
  "paths": {
3
    "/v2/orders": {
4
      "post": {
5
        "summary": "Create Order",
6
        "parameters": [
7
          + { "name": "billing_zip", "in": "query", "required": true }
8
        ]
9
      }
10
    }
11
  }
12
}

Frequently Asked Questions

Platform Release Changelog

v1.4.2 — LATEST RELEASE
August 2026

Signature Pipeline Control Center & AI Docs Assistant

  • Added interactive 6-stage execution control center playback bar (`Play/Pause`, `Step`, `1x/2x/5x`).
  • Released persistent DRIFT Contract AI Assistant drawer for instant breaking change explanations.
  • Upgraded OpenAPI 3.1 schema dereferencing parser engine to sub-15ms parsing.
v1.3.0
July 2026

Shadow Traffic Replay Engine

  • Introduced eBPF packet mirror integration for 50,000+ request shadow replay.
  • Added multi-format report generator (CLI text, JSON schema payload, HTML summary).
Enterprise Deployment

Ready to use DRIFT in Your Workflow?

Explore enterprise pricing plans, deployment options, air-gapped security, and team licenses.