Skip to content

Your First Report Card

After running certify certify, you can generate your full report card:

Terminal window
certify report --format full

This creates .certification/REPORT_CARD.md — a complete per-unit certification of your entire codebase.

The top section shows your overall certification status:

MetricWhat it means
Overall GradeWeighted average across all units (A through F)
Overall ScorePercentage score (0–100%)
Total UnitsNumber of certifiable code units found
PassingUnits meeting all policy requirements
FailingUnits that fail required policies
Pass RatePercentage of units passing
ObservationsPassing units with minor warnings
ExpiredUnits whose certification window has elapsed

Your codebase scored across 9 quality dimensions with visual bars:

| correctness | 95.0% | ██████████████████░░ |
| maintainability | 93.3% | ██████████████████░░ |
| readability | 92.4% | ██████████████████░░ |

This tells you which quality areas are strongest and where to focus improvement.

Breakdown by detected language — each showing unit count, average score, score range, and grade distribution.

Every single unit organized by directory:

| Score | function | B+ | 87.4% | certified | 2026-06-07 |
| CertifyUnit | function | B | 85.6% | certified | 2026-06-07 |

Units with observations or non-passing status get expandable detail sections showing per-dimension scores and specific observations.

FormatCommandUse case
Card--format card (default)Quick terminal summary
Full--format fullComplete markdown report card
Site--format site or --siteBrowsable static HTML site
JSON--format jsonMachine-readable for tooling
Text--format textBrief health summary

Every certify report run also generates a report tree — individual markdown files for every unit in reports/:

.certification/reports/
├── index.md
├── internal/engine/scorer.go/
│ ├── Score.md
│ └── CertifyUnit.md

Each file contains the full certification record with dimension scores, evidence, and observations. GitHub renders these as navigable documentation.

For large repos, generate a browsable HTML site:

Terminal window
certify report --site

The site includes per-package pages, per-unit detail, dimension charts, and client-side search — all static files that work offline.

Every certify report run saves:

  • .certification/REPORT_CARD.md — full per-unit report card
  • .certification/badge.json — shields.io badge endpoint
  • .certification/reports/ — per-unit markdown report tree

These are committed to your repository so they’re always visible on GitHub.