CLI Reference

Analyze Markdown files from the command line.

Install

go install github.com/adaptive-enforcement-lab/readability/cmd/readability@latest

Other Options

See Installation for binaries and building from source.

Basic Usage

# Check a file
readability README.md

# Check a folder
readability docs/

# Fail if issues found (for CI)
readability --check docs/

Options

Flag	Short	Purpose
--format	-f	Output format
--check		Exit 1 on failures
--config	-c	Config file path
--verbose	-v	Show all metrics

Output Formats

Format	Best For
table	Reading in terminal
markdown	GitHub summaries
json	Scripts
diagnostic	IDEs and linters

Threshold Flags

Set limits from the command line:

readability --max-grade 12 --max-ari 12 docs/

Flag	Controls
--max-grade	Grade level limit
--max-ari	ARI score limit
--max-lines	File length limit
--min-admonitions	Required callouts

More Info

• Commands - All flags
• Config File - Save settings
• Diagnostic Output - IDE setup