See the decision
before you commit
What this gate does. Advisory. The extension marks the editor; it cannot stop a commit, a merge or a deploy.
The extension marks the pattern on the line. A risk score and a consumer count are a detail, not the decision. The sample below is that shape. The extension README at 1.0.1 is not edited from this page.
Quick start
Install the extension
Search for "CodeRifts" in the VS Code Extensions panel, or run:
ext install Coderifts.coderifts-vscode
Add your API key
Open VS Code Settings and add your CodeRifts API key:
{
"coderifts.apiKey": "cr_live_..."
}
Open an OpenAPI file
Open any .yaml, .yml, or .json OpenAPI spec. Save the file — CodeRifts automatically compares against the git HEAD baseline and shows inline diagnostics.
Features
Real-time diff on save
Every time you save an OpenAPI file, the extension fetches the git HEAD baseline (git show HEAD:<file>), sends both versions to the CodeRifts API, and updates diagnostics in under a second. That is the raw-spec path: it compares two whole specifications. The description-level checks that run on a change set — the ones that read what a tool description gained — are not on this path, so the extension will not flag an instruction added to a tool description. Measured 2026-09-15.
Inline diagnostics
Breaking changes appear as squiggly lines directly on the affected lines. Red for BLOCK-level (endpoint removed, auth changed), yellow for WARN (field removed, type changed), blue for INFO (risky but non-breaking).
Status bar item
The status bar shows the current analysis state at a glance. Click to open the Analysis Panel.
Analysis Panel
The panel lists the breaking patterns. A risk score, when the extension prints one, is a detail, not the decision.
Installation
Three installation methods are available.
VS Code Marketplace (recommended)
Search for "CodeRifts" in the VS Code Extensions panel (Ctrl+Shift+X), or use the Quick Open command:
ext install Coderifts.coderifts-vscodeOpen in VS Code Marketplace
Manual install via npm
The extension is also published to npm for programmatic install or CI environments:
npm install @coderifts/vscode-extension
Or check the latest version:
npm info @coderifts/vscode-extension version
VSIX — air-gapped or policy-restricted installs
For environments that cannot reach the Marketplace, or that permit only reviewed artifacts. Download the .vsix from the latest GitHub release, then:
code --install-extension coderifts-vscode-1.0.0.vsix
Or use Install from VSIX… in the Extensions panel’s ... menu.
Configuration
All settings live under the coderifts.* namespace in your VS Code settings.json.
{
// Your CodeRifts API key — get one at app.coderifts.com
"coderifts.apiKey": "cr_live_your_key_here",
// API base URL (advanced — do not change unless self-hosting)
"coderifts.apiUrl": "https://app.coderifts.com",
// Analyze automatically on every save (default: true)
"coderifts.autoAnalyze": true,
// Show inline squiggly lines (default: true)
"coderifts.showInlineHints": true,
// Minimum severity to show: "error" | "warning" | "information"
"coderifts.severity": "warning"
}
| 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 |
Start catching breaking changes in your editor
Install the extension, add your API key, and get inline feedback on every save. Free during beta.