Skip to content

Commit b748eb1

Browse files
hyhmrrightclaude
andcommitted
docs: add brooks-health to README slash commands and usage section
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 84d846e commit b748eb1

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ cp -r /tmp/brooks-lint/skills/* ~/.codex/skills/brooks-lint/
243243
| `/brooks-lint:brooks-audit` | `/brooks-audit` | Full architecture audit |
244244
| `/brooks-lint:brooks-debt` | `/brooks-debt` | Tech debt assessment |
245245
| `/brooks-lint:brooks-test` | `/brooks-test` | Test suite health review |
246+
| `/brooks-lint:brooks-health` | `/brooks-health` | Health dashboard — all four dimensions |
246247

247248
> Short-form commands are auto-installed on first session start by the session-start hook.
248249
@@ -253,6 +254,7 @@ cp -r /tmp/brooks-lint/skills/* ~/.codex/skills/brooks-lint/
253254
| `/brooks-audit` | Full architecture audit |
254255
| `/brooks-debt` | Tech debt assessment |
255256
| `/brooks-test` | Test suite health review |
257+
| `/brooks-health` | Health dashboard — all four dimensions |
256258

257259
### Codex CLI
258260

@@ -262,6 +264,7 @@ cp -r /tmp/brooks-lint/skills/* ~/.codex/skills/brooks-lint/
262264
| `$brooks-audit` | Full architecture audit |
263265
| `$brooks-debt` | Tech debt assessment |
264266
| `$brooks-test` | Test suite health review |
267+
| `$brooks-health` | Health dashboard — all four dimensions |
265268

266269
The skills also trigger automatically when you discuss code quality, architecture, maintainability, or test health.
267270

@@ -307,6 +310,16 @@ $brooks-test # Codex CLI
307310

308311
Audits your test suite against six test-space decay risks — Test Obscurity, Test Brittleness, Test Duplication, Mock Abuse, Coverage Illusion, and Architecture Mismatch — sourced from xUnit Test Patterns, The Art of Unit Testing, How Google Tests Software, and Working Effectively with Legacy Code. PR reviews also include a lightweight Step 7 Quick Test Check automatically.
309312

313+
### Health Dashboard
314+
315+
```
316+
/brooks-health # Claude Code (short form) / Gemini CLI
317+
/brooks-lint:brooks-health # Claude Code (full form)
318+
$brooks-health # Codex CLI
319+
```
320+
321+
Runs abbreviated scans across all four quality dimensions and produces a weighted composite Health Score (0–100). Use it before a release, when onboarding a new team, or whenever you want a big-picture "how are we doing?" report. For deeper diagnosis on any dimension, use the focused skill instead.
322+
310323
## Configuration
311324

312325
Place a `.brooks-lint.yaml` in your project root to customize review behavior:

0 commit comments

Comments
 (0)