Health Score Badge

Badge grades

The health score combines four dimensions: dead code percentage, circular dependencies, coupling (max fan-in), and security issues. Each dimension is equally weighted to produce a letter grade.

Grade breakdown

A (90–100) — Excellent structure, minimal dead code, no circular deps, low coupling, no security flags.
B (75–89) — Good health with minor issues. Most well-maintained projects land here.
C (60–74) — Noticeable structural issues. Worth investigating god nodes and coupling.
D (40–59) — Significant structural problems. Refactoring recommended.
F (0–39) — Critical issues across multiple dimensions.

Add the badge to your README

1. Run the audit on your project to get your grade:
   $ sverklo audit
2. Copy the badge markdown and paste it into your README.md:
   copy [](https://sverklo.com)

   Replace the grade letter and color to match your score:

   A → brightgreen B → green C → yellow D → orange F → red
3. That's it. Your README now signals code health to every visitor. When the badge API launches, your badge will auto-update on every push.

Dynamic badges (recommended)

Publish your grade so the badge auto-updates from the real audit. Run this from your project:

This runs the audit, publishes the grade, and gives you a dynamic badge URL:

The badge always reflects the last published audit. Re-run sverklo audit --publish after changes to update it. Add it to CI for automatic updates on every push.

Why add a health badge?

For maintainers: Signal that you care about structural quality, not just test coverage. The health score catches what coverage badges miss — god classes, circular dependencies, dead code, and coupling hotspots.

For contributors: Understand the codebase health before diving in. A project with an A grade is structurally clean. A D grade means expect complexity.

For evaluators: When choosing between similar libraries, the health badge gives a quick structural quality signal alongside stars and downloads.