Skip to content
unfault

Quick Start

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

Run Your First Review

Section titled “Run Your First Review”

Navigate to your project directory and run:

Terminal window
unfault review

Unfault will analyze your codebase and display findings in your terminal.

Understanding Output

Section titled “Understanding Output”

A typical review produces output like this:

→ Analyzing rag-app...
  Languages: python
  Frameworks: fastapi
  Dimensions: stability, correctness, performance
  Found 1 matching source files
  Reviewed in 282ms (trace: 13260fc6)


⚠ Found 11 issues


🟠 High (3 issues)
   [python.db.missing_timeout] Database create_engine call without timeout (1x)
   [python.http.blocking_in_async] Blocking HTTP call via `requests.get` inside async function `fetch_external_data` (1x)
   [python.resilience.missing_circuit_breaker] HTTP call to external service in `fetch_external_data` lacks circuit breaker protection (1x)


🟡 Medium (7 issues)
   [fastapi.missing_cors] FastAPI app `app` has no CORS middleware configured (1x)
   [python.fastapi.missing_exception_handler] FastAPI app `app` has no exception handlers (1x)
   [python.fastapi.missing_request_timeout] FastAPI app `app` has no request timeout middleware (1x)
   [python.http.missing_retry] HTTP call via `requests`.get has no retry policy (1x)
   [python.http.missing_timeout] HTTP call via `requests`.get has no timeout (1x)
   [python.missing_correlation_id] FastAPI app 'app' missing correlation ID middleware (1x)
   [python.sqlalchemy.pgvector_suboptimal_query] pgvector: Missing LIMIT on vector similarity query (1x)


🔵 Low (1 issue)
   [python.sqlalchemy.pgvector_suboptimal_query] pgvector: Use inner product (<#>) instead of cosine (<=>) (1x)

Note the color coding:

  • 🟠 High: Issues that could cause production failuresand should be attended to first
  • 🟡 Medium: Important but not immediately critical
  • 🔵 Low: Minor improvements

Viewing Suggested Fixes

Section titled “Viewing Suggested Fixes”

To see the full details with patches:

Terminal window
unfault review --output full

This shows the suggested code change for each issue.

Output Formats

Section titled “Output Formats”

Choose the format that fits your workflow:

Terminal window
# Grouped by severity
unfault review

Filtering by Dimension

Section titled “Filtering by Dimension”

Focus on specific types of issues:

Terminal window
# 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

Section titled “CI/CD Integration”

Use exit codes to gate deployments:

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

Next Steps

Section titled “Next Steps”
CLI Commands Learn about all CLI commands in detail.
VS Code Integration Get real-time feedback as you code.
CI/CD Pipeline Add Unfault to your build process.