Quick Start

This guide walks you through running your first review and understanding the results.

Run Your First Review

Navigate to your project directory and run:

unfault review

Unfault analyzes your codebase and shows what it finds:

Looks good overall, with a couple spots that deserve a closer look. Two themes
keep showing up: other cleanup and resilience hardening. Starting point:
weather.py (HTTP call to external service in `get_weather` lacks circuit
breake...); then weather.py (FastAPI app 'app' missing correlation ID
middleware).

At a glance
  · 2 calls without timeouts - could hang if a service is slow
  · Circuit breakers would help fail fast when dependencies are down
  · Rate limiting would protect against abuse
  · CORS config needed if browsers will call this API

────────────────────────────────────────────────────────────────────────────────
1112ms - python / fastapi - 1 file
Tip: use --output full to drill into hotspots.

The summary tells you what matters. It identifies patterns, suggests where to start, and explains why.

Drilling Into Details

To see the full findings with suggested fixes:

unfault review --output full

This shows each finding with its location, explanation, and a suggested code change.

Output Formats

Choose the format that fits your workflow:

# Grouped by severity
unfault review

# Summary statistics only
unfault review --output concise

# Full details with diffs
unfault review --output full

# Machine-readable for CI/CD
unfault review --output json

# Code Scanning ready
unfault review --output sarif

Filtering by Dimension

Focus on specific types of issues:

# Only stability issues
unfault review --dimension stability

# Only performance issues
unfault review --dimension performance

# Multiple dimensions
unfault review --dimension stability --dimension correctness

CI/CD Integration

Use exit codes to gate deployments:

unfault review
if [ $? -eq 5 ]; then
  echo "Production readiness issues found. Blocking deployment."
  exit 1
fi