Documentation
Learn how to use Vipr
Guides, references, and tutorials for installing the CLI, running analysis, and integrating Vipr into CI.
Quick start
Installation
Install and run the Vipr CLI with npm, npx, pnpm, or yarn.
Read guideFirst Analysis
Run your first Vipr analysis and explore the results.
Read guideConfiguration
Customize Vipr behavior with vipr.config.json - thresholds, ignore patterns, output settings, and layered overrides.
Read guideProduct guides
VSCode Extension Guide
Set up the Vipr VSCode extension for inline diagnostics, code analysis, and Pro features.
Desktop App Guide
Install and use the Vipr desktop dashboard for historical analysis, trend tracking, and team metrics.
CLI Guide
Install, configure, and use the Vipr CLI for local analysis, automation, and CI quality gates.
Popular topics
Integration
API reference
CLI API Reference
Public command contract for the Vipr CLI, including commands, flags, output formats, configuration precedence, and quality gates.