DocsCliScore

quell score

Scans your project's source files, extracts all requirements from docstrings and Pydantic models, and shows how many are covered by existing tests.

Usage

quell score [OPTIONS]

Options

OptionDefaultDescription
--badgeFalseGenerate .quell/badge.svg
--root.Project root directory

Examples

# Show score in terminal
quell score

# Generate SVG badge
quell score --badge

Console output

Quell Score by File
File               Requirements   Covered   Score   Grade
payments.py                   5         4     80%       B
auth.py                       8         7     87%       A
calculator.py                 6         6    100%       A

Project Score: 86%

Grade thresholds

GradeScore range
A>= 80%
B60–79%
C40–59%
F< 40%

SVG badge

quell score --badge
# Writes .quell/badge.svg

The badge follows shields.io style:

  • Green: score >= 80%
  • Yellow: score 60–79%
  • Red: score < 60%

Add to your README:

![Quell Score](.quell/badge.svg)