CodeRifts — API Breaking Change Detector

Real-time breaking change detection for OpenAPI specs, right inside VS Code.

Get inline diagnostics, status bar alerts, and a full risk analysis panel as you edit your OpenAPI/Swagger files — before commit, before PR, before CI.

Install

From the Marketplace (recommended)

Search for CodeRifts in the Extensions panel (Ctrl/Cmd+Shift+X), or:

code --install-extension Coderifts.coderifts-vscode

View on the Visual Studio Marketplace

The identifier is Coderifts.coderifts-vscode with a capital C — that is the casing the Marketplace assigned. The web link resolves either way, but use the capital form in --install-extension, which is the case-sensitive path.

From VSIX — for air-gapped or policy-restricted installs

Kept deliberately: some environments cannot reach the Marketplace, and some organisations allow only reviewed artifacts. This route is not a fallback for a missing listing — the listing exists — it is the supported path for those cases.

Download coderifts-vscode-1.0.0.vsix from the latest GitHub release.
In VS Code, open the Extensions panel (Ctrl/Cmd+Shift+X).
Click the ... menu at the top-right of the panel, then Install from VSIX...
Select the downloaded .vsix file.

Or from the CLI:

code --install-extension coderifts-vscode-1.0.0.vsix

Quick Start

Add your API key to VS Code settings:
```
{
  "coderifts.apiKey": "cr_live_your_key_here"
}
```
Get a free API key at app.coderifts.com/api/signup.
Open an OpenAPI file (.yaml, .yml, or .json matching OpenAPI patterns).
Save the file — CodeRifts automatically compares your changes against the git HEAD baseline and shows inline diagnostics.

Features

Real-time diff on save

When you save an OpenAPI file, the extension:

Fetches the git baseline (git show HEAD:<file>)
Sends both versions to the CodeRifts API
Shows inline squiggly lines for breaking changes
Updates the status bar with a summary

Inline diagnostics

Squiggly colour	Severity	Example
Red (error)	BLOCK — deployment-blocking	Endpoint removed, auth changed
Yellow (warning)	WARN — breaking for consumers	Field removed, type changed
Blue (information)	INFO — risky but not breaking	Description changed, new optional field

Example diagnostic message:

CodeRifts: ENDPOINT_REMOVAL — DELETE /users/legacy — Risk: BLOCK | P_break: 0.89 | Blast radius: 3 consumers

Status bar

The status bar shows the current analysis state:

Status	Meaning
`$(shield) CodeRifts: SAFE`	No breaking changes
`$(warning) CodeRifts: 3 warnings`	Warning-level changes
`$(error) CodeRifts: BLOCK (13 breaking)`	Deployment-blocking changes

Click the status bar item to open the Analysis Panel.

Analysis Panel

A dedicated sidebar panel showing:

Current file analysis results
Risk score (0–100)
Breaking changes list with severity
Synaptic weight of changed endpoints
Token cost impact
"View in Dashboard" link

Commands

Command	Description
`CodeRifts: Analyze Current File`	Manually trigger analysis
`CodeRifts: Open Dashboard`	Open app.coderifts.com
`CodeRifts: Configure Settings`	Open CodeRifts settings
`CodeRifts: Clear Diagnostics`	Remove all squiggly lines

Configuration

All settings are under the coderifts.* namespace:

Setting	Default	Description
`coderifts.apiKey`	`""`	Your CodeRifts API key
`coderifts.apiUrl`	`https://app.coderifts.com`	API base URL
`coderifts.autoAnalyze`	`true`	Analyze on save
`coderifts.showInlineHints`	`true`	Show squiggly lines
`coderifts.severity`	`"warning"`	Minimum severity to show

Requirements

VS Code 1.85+
Git installed and available in PATH
A CodeRifts API key (get one free)

CodeRifts