Skip to main content

First Analysis

Analyze a project

Point Vipr at your source files:

vipr analyze "src/**/*.{ts,tsx}"

If you prefer, analyze is also the default command:

vipr "src/**/*.{ts,tsx}"

Vipr scans every matched file and returns:

  • An overall score per file so you can spot the worst offenders first
  • Plugin-specific metrics from the Core, React, Next.js, and TypeScript analyzers
  • Insights with severity, location, and suggestions when Vipr finds problems
  • Errors and warnings when a file cannot be analyzed cleanly

Reading the output

The default cli output groups findings by severity:

  • Critical — files that need immediate attention
  • Warning — issues that will become problems if left unchecked
  • Info — observations and suggestions

Use a different format when the terminal view is not the best fit:

# Structured output for CI and scripts
vipr analyze "src/**/*.{ts,tsx}" --format json --output vipr-report.json

# Markdown for pull requests and issue comments
vipr analyze "src/**/*.{ts,tsx}" --format markdown --output vipr-report.md

Interactive mode

If you run Vipr in a TTY without passing files, it starts the interactive workflow automatically:

vipr

You can also force that flow explicitly:

vipr -i

Next steps

Documentation