Copy/Paste Oneliners

No explanation needed. Just copy, paste, and run.

Before You Commit

# Summary review: header + findings narrative
unfault review

# All findings grouped by severity and rule (linter view)
unfault lint

# Detailed output with suggested fixes
unfault review --output full

# Machine-readable JSON
unfault review --output json

# Focus on stability only
unfault review --dimension stability

For Coding Agents

Structured output for Claude, Cursor, Copilot, and other AI assistants.

# JSON output for programmatic parsing
unfault review --output json

# Focus on specific dimensions
unfault review --dimension stability --output json
unfault review --dimension correctness --output json

# Impact analysis before changes
unfault graph impact src/api/routes.py --json
unfault graph critical --json --limit 5

Paste Into Your Agent

Add this to your AGENTS.md or system prompt:

Before committing, run:
\`\`\`bash
unfault review --output json
\`\`\`

If high-severity findings are reported, address them before committing.
Before changing a file, check its blast radius:
\`\`\`bash
unfault graph impact <file>
\`\`\`

CI/CD Pipelines

GitHub Actions

# SARIF for GitHub Code Scanning
unfault review --output sarif > results.sarif

- name: Run Unfault
  run: unfault review --output sarif > results.sarif

- name: Upload SARIF
  uses: github/codeql-action/upload-sarif@v3
  with:
    sarif_file: results.sarif

Exit Code Checks

# Fail if findings detected (exit 5)
unfault review && echo "Clean!" || echo "Findings found"

# Explicit check
unfault review --output json
if [ $? -eq 5 ]; then
  echo "Review the findings above"
  exit 1
fi

JSON for Custom Processing

# Pipe to jq for filtering
unfault review --output json | jq '.contexts[].findings | map(select(.severity == "High"))'

# Count findings
unfault review --output json | jq '[.contexts[].findings] | flatten | length'

Deep Analysis

# Full detailed output with suggested fixes
unfault review --output full

# Focus on one dimension
unfault review --dimension stability --output full
unfault review --dimension performance --output full
unfault review --dimension correctness --output full

# Preview fixes without applying
unfault review --dry-run

Impact Analysis

# What breaks if I change this file?
unfault graph impact src/core/auth.py

# Find the most connected files
unfault graph critical --limit 10

# What uses this library?
unfault graph library requests
unfault graph library httpx

# External dependencies of a file
unfault graph deps src/api/client.py

# Graph statistics
unfault graph stats

Configuration

# Configure LLM for AI-powered review summaries
unfault config llm openai --model gpt-4o
unfault config llm anthropic --model claude-3-5-sonnet-latest
unfault config llm ollama --model llama3.2

# View current config
unfault config show
unfault config llm show

# Check observability integrations
unfault config integrations show
unfault config integrations verify

Quick Reference

Flag	What it does
`--output full`	Detailed output with fix suggestions
`--output json`	Machine-readable JSON
`--output sarif`	SARIF 2.1.0 for GitHub/IDE integration
`--output concise`	Brief statistics only
`--dimension X`	Focus on one dimension
`--dry-run`	Preview fixes without applying
`--fix`	Auto-apply suggested fixes
`--offline`	Skip SLO and trace fetching
`--refresh-cache`	Re-fetch observability data

Exit Codes

Code	Meaning
0	Success, no findings
5	Success, findings detected
1	General error
2	Config error
4	Network error
6	Invalid input