Skip to main content

VSCode Extension Guide

Installation

Search for "Vipr" in the VSCode Extensions panel, or install from the VSCode Marketplace or Open VSX.

The extension also works in Cursor and Windsurf.

Features

Free tier

  • Inline diagnostics for complexity and anti-patterns
  • File-level complexity scores in the explorer
  • Problems panel integration

Pro tier

  • CodeLens scores on every function
  • Copilot Chat participant (@techdebt)
  • Dashboard webview with project-wide metrics

Activation

The extension activates automatically when you open a workspace containing .ts, .tsx, .js, or .jsx files. Check the status bar for the Vipr icon to confirm activation.

Workspace configuration

The extension loads the same canonical vipr.config.json implementation as the CLI. It discovers the file by walking up from the workspace folder, applies include, exclude, and global.ignorePatterns before workspace analysis, and clears extension caches when the config file changes.

Use the "Vipr: Init Config" command to create vipr.config.json at the detected Git repository root. The extension does not create .vipr.config.json.

Config-managed budgets live under the budgets key. VS Code reads and writes that key so Desktop can import the same budgets as read-only deterministic entries.

Documentation