Quickstart

Run Code Buster from the repository you want to analyze. Configuration is optional.

Analyze production source

cb summary

The default analysis detects supported languages and frameworks, selects production source, and classifies conventional tests, examples, fixtures, benchmarks, generated code, and vendored files separately.

For a machine-readable report:

cb summary --format json

Include auxiliary source

cb summary --include-tests
cb summary --include-examples
cb summary --include-vendored
cb summary --all

The summary coverage ledger distinguishes selected, test, example, vendored, generated, unsupported, binary, ignored, and unchanged files. Inclusion changes selection; it does not erase classification.

Explain selection and findings

cb inspect path/to/file.dart
cb explain <rule-id>
cb why path/to/file.dart
cb related path/to/file.dart

Use inspect to understand file classification. Use explain for rule rationale and remediation. Use why, related, and path when investigating repository wiring.

Review quality

cb score
cb quality
cb hotspots
cb plan
cb actions
cb review

These views organize the same analysis evidence for different decisions: prioritization, quality gates, high-risk areas, remediation, and code review.

Add configuration only when needed

cb init
cb config explain

cb init creates a minimal code-buster.toml. cb config explain displays effective defaults, inferred repository policy, file configuration, environment input, and CLI overrides.