Quick Start¶

Your First Analysis¶

Run readability on a directory:

readability docs/

Output:

┌─────────────────────────┬───────┬───────────┬─────────┐
│ File                    │ Grade │ Flesch    │ Status  │
├─────────────────────────┼───────┼───────────┼─────────┤
│ docs/index.md           │ 8.2   │ 62.5      │ pass    │
│ docs/getting-started.md │ 10.1  │ 55.3      │ pass    │
│ docs/api-reference.md   │ 14.5  │ 38.2      │ fail    │
└─────────────────────────┴───────┴───────────┴─────────┘

Output Formats¶

Markdown¶

readability --format markdown docs/

JSON¶

readability --format json docs/

Summary¶

readability --format summary docs/

Check Mode¶

Fail if thresholds are exceeded:

readability --check --max-grade 12 docs/

Exit code 1 if any file exceeds grade level 12.

Configuration File¶

Create .content-analyzer.yml:

thresholds:
  max_grade: 12
  max_ari: 12
  max_lines: 500

Then run without flags:

readability docs/