Skip to content

phx:audit

Project health audit and health check — architecture, performance, security, tests, dependencies. Use quarterly, before releases, after refactors, or when asked about project health. · effort: high

Project Health Audit

Comprehensive project-wide health assessment using 5 parallel specialist subagents.

Usage

/phx:audit # Full audit (default)
/phx:audit --quick # 2-3 minute pulse check
/phx:audit --focus=security # Deep dive single area
/phx:audit --focus=performance
/phx:audit --since abc123 # Incremental audit since commit
/phx:audit --since HEAD~10 # Audit last 10 commits

When to Use

  • Quarterly health checks
  • Before major releases
  • After large refactors
  • New team member onboarding (understand codebase health)

Iron Laws

  1. Wait for ALL agents before synthesizing — Partial results create misleading health scores because cross-category correlations get missed
  2. Scope agent prompts to specific directories — Vague prompts like “analyze the codebase” produce generic findings that waste tokens and miss real issues
  3. Never compare scores across projects — Scoring methodology depends on project size and maturity; only track trends within the same project
  4. Quick mode before full mode — Run --quick first to catch compile/test failures before spending tokens on 5 parallel agents

Subagent Architecture

Spawn 5 specialists in parallel using Agent tool:

SubagentFocusOutput File
Architecture ReviewerStructure quality, coupling, cohesionarch-review.md
Performance AuditorN+1, indexes, bottlenecks, scalabilityperf-audit.md
Security AuditorOWASP scan, auth patterns, secretssecurity-audit.md
Test Health AuditorCoverage, quality, flaky teststest-audit.md
Dependency AuditorVulnerabilities, outdated, unuseddeps-audit.md

Workflow

Step 1: Create Task List and Spawn All 5 Auditors (Parallel)

Create Claude Code tasks for real-time progress visibility:

For each auditor:
TaskCreate({subject: "{Area} audit", activeForm: "Auditing {area}..."})
TaskUpdate({taskId, status: "in_progress"})

Then spawn all 5 agents with Agent tool (parallel):

Agent(subagent_type: "general-purpose", prompt: "Architecture audit...", run_in_background: true)
Agent(subagent_type: "general-purpose", prompt: "Performance audit...", run_in_background: true)
Agent(subagent_type: "general-purpose", prompt: "Security audit...", run_in_background: true)
Agent(subagent_type: "general-purpose", prompt: "Test health audit...", run_in_background: true)
Agent(subagent_type: "general-purpose", prompt: "Dependency audit...", run_in_background: true)

Agent prompts must be FOCUSED. Scope each prompt to the relevant directories and patterns. Do NOT give vague prompts like “analyze the codebase.”

Output efficiency: Tell each agent: “Report ONLY issues found. Do NOT list clean checks, passing categories, or ‘What’s Good’. One summary line per clean area suffices.”

Step 2: Collect Results

Wait for ALL auditors to complete. Mark each auditor’s task as completed via TaskUpdate as it finishes. NEVER proceed while any auditor is still running.

Read reports from .claude/audit/reports/.

Step 3: Compress Findings

After all 5 auditors complete, spawn context-supervisor:

Agent(subagent_type: "context-supervisor", prompt: """
Compress audit findings.
Input: .claude/audit/reports/
Output: .claude/audit/summaries/
Priority: Health scores per category, critical findings
only, cross-category correlations, deduplicate findings
found by 2+ agents.
""")

Read .claude/audit/summaries/consolidated.md for synthesis.

Step 4: Calculate Health Score

Each category scores 0-100. See ${CLAUDE_SKILL_DIR}/references/scoring-methodology.md.

Step 5: Generate Report

Write to .claude/audit/summaries/project-health-{date}.md.

Output Format

Report includes: Executive summary with health score (A-F, numeric/100), per-category score table (Architecture, Performance, Security, Tests, Dependencies), critical issues, top recommendations, and action plan (Immediate/Short-term/Long-term).

Quick Mode (--quick)

Only run essential checks (~2-3 minutes):

Run mix compile --warnings-as-errors, then mix hex.audit && mix deps.audit, then mix xref graph --format stats, then mix test --trace 2>&1 | tail -20.

Skip: Full security scan, N+1 analysis, test quality metrics, architecture deep dive.

Focus Mode (--focus=area)

Deep dive single area with full specialist resources:

FocusSubagentExtra Checks
securitysecurity-analyzerFull OWASP, sobelow, manual patterns
performance(performance subagent)Profile-level analysis, query explain
architecture(arch subagent)Full xref, coupling matrix, cohesion
teststesting-reviewerCoverage by context, quality metrics
deps(deps subagent)License audit, maintenance status

Incremental Mode (--since <commit>)

Analyze only changes since a specific commit. Useful for pre-merge checks:

Run git diff --name-only <commit>...HEAD to identify changed files, then run targeted audits on changed files only (skips full project scan).

Combines with other flags: /phx:audit --since HEAD~5 --focus=security

Relationship to Other Commands

CommandScopeFrequency
/phx:reviewChanged files (diff)Every PR
/phx:auditEntire projectQuarterly
/phx:boundariesContext structureOn-demand
/phx:verifyCompile/test passAnytime

References

  • ${CLAUDE_SKILL_DIR}/references/scoring-methodology.md - How scores are calculated
  • ${CLAUDE_SKILL_DIR}/references/architecture-checks.md - Detailed architecture criteria

phxagents · v2.8.8 · GitHub · llms.txt · llms-full.txt

Community plugin. Not affiliated with Phoenix Framework or phoenix.new.