Quick start

This page walks through linting your first document.

Lint a single file

lucid-lint check README.md

Output:

warning <path>/README.md:14:1 Sentence is 27 words long (maximum 22). Consider splitting it into shorter sentences. [structure.sentence-too-long]

summary: 1 warnings.
→ run 'lucid-lint explain <rule-id>' — seen here: structure.sentence-too-long
────────────────────────────────────────────────────────────
score: 88/100
       structure    ██▏░░  8/20
       rhythm       █████  20/20
       lexicon      █████  20/20
       syntax       █████  20/20
       readability  █████  20/20

The trailing block is the scoring summary — a global X / 100 score followed by the full per-category breakdown.

Lint several files

lucid-lint check docs/*.md CHANGELOG.md

Lint a directory

lucid-lint check docs/

All files with .md, .markdown, or .txt extensions will be processed.

Use stdin

echo "This is a test sentence." | lucid-lint check -

Pipe from Pandoc

For formats that lucid-lint does not parse natively yet:

pandoc report.docx -t markdown | lucid-lint check -

Choose a profile

# Strictest: Easy-to-Read
lucid-lint check --profile=falc docs/

# Looser: developer documentation
lucid-lint check --profile=dev-doc docs/

See Profiles for details.

Change the output format

# JSON for CI
lucid-lint check --format=json docs/

See CI integration for CI recipes.

Exit codes

The two gates stack. See CI integration for combination recipes.