CLI

Exit codes: 0 pass · 1 regression · 2 invalid.

Get started: dart run frameguard help

Setup

dart run frameguard init
dart run frameguard doctor
dart run frameguard profiles
dart run frameguard config validate

Inspect & explain

dart run frameguard list
dart run frameguard inspect report.json --format json
dart run frameguard explain report.json
dart run frameguard frames report.json --limit 20 --janky-only
dart run frameguard regions report.json
dart run frameguard tasks report.json
dart run frameguard stats report.json
dart run frameguard top report.json
dart run frameguard histogram report.json
dart run frameguard validate reports/

Gates & history

dart run frameguard check reports/ --baseline baselines/ --profile mid_range --require-profile
dart run frameguard check reports/ --record-history
dart run frameguard suggest-budget reports/x.json --format dart
dart run frameguard history append reports/x.json
dart run frameguard history show x --limit 20
dart run frameguard history drift x
dart run frameguard compare baseline.json current.json
dart run frameguard diff a.json b.json --format markdown
dart run frameguard merge run1.json run2.json run3.json --stats
dart run frameguard drift baselines/
dart run frameguard baseline update reports/x.json --out baselines/x.json
dart run frameguard baseline list
dart run frameguard watch reports/ --baseline baselines/catalog.json

Export & CI

dart run frameguard summary report.json --format markdown >> "$GITHUB_STEP_SUMMARY"
dart run frameguard export report.json --format junit --out perf.xml
dart run frameguard artifacts report.json --dir reports
dart run frameguard batch reports/ --format junit --out-dir reports/exports --check
dart run frameguard completions --shell bash >> ~/.bashrc