bootspring audit

Quality, security, and best practices audit for your codebase.

Overview#

The audit command performs comprehensive quality and security audits, identifying issues and generating prioritized recommendations. Perfect for code reviews, security assessments, and maintaining code health.

Usage#

bootspring audit [command] [options]

Commands#

CommandDescription
(default)Run full audit
statusShow current progress
resumeContinue from checkpoint
resetReset workflow state

Options#

OptionDescription
--phase=<phase>Run specific phase only
--severity=<level>Filter by severity: critical, high, medium, low
--fixAuto-fix safe issues where possible
--ciCI mode with exit codes

Audit Phases#

PhaseDescription
qualityCode quality metrics (complexity, duplication)
securitySecurity scan (secrets, vulnerabilities)
performancePerformance analysis
practicesBest practices checks
techDebtTech debt inventory
recommendationsGenerate prioritized recommendations

Severity Levels#

LevelDefinitionAction
CRITICALSecurity vulnerability, data loss riskImmediate
HIGHMajor issue, significant risk1-2 days
MEDIUMModerate issue, tech debt1-2 weeks
LOWMinor, optimization opportunityBacklog

CI Mode#

When running in CI mode, the command returns exit codes:

Exit CodeMeaning
0All checks passed
1High severity issues found
2Critical issues found
# In CI pipeline bootspring audit --ci

Output#

Audit generates a report at /planning/AUDIT_REPORT.md containing:

  • Executive summary with scores
  • Critical/high findings with remediation
  • Quality metrics table
  • Security vulnerabilities table
  • Tech debt inventory
  • Prioritized recommendations

Examples#

1# Full audit 2bootspring audit 3 4# Run specific phase 5bootspring audit --phase=security 6 7# Filter by severity 8bootspring audit --severity=high 9 10# Auto-fix safe issues 11bootspring audit --fix 12 13# CI mode 14bootspring audit --ci 15 16# Check progress 17bootspring audit status 18 19# Resume after interruption 20bootspring audit resume