home / dev-tools / vale

Vale

5.3k

Prose linting CLI for docs, markup files, and code comments using configurable editorial style rules.

$brew install vale
Language
Go
Stars
5,277
Category
Dev Tools
Agent
Ready
Agent Compatibility
JSON Output
Agent Skill
MCP Support
AI Analysis

Vale is a prose linter for documentation, markup files, and supported code comments that applies configurable style, spelling, readability, and terminology rules from a local .vale.ini and styles tree. It is built for docs review, editor integration, and CI enforcement rather than terminal-first authoring.

What It Enables
  • Lint Markdown, AsciiDoc, reStructuredText, HTML, XML, Org, plain text, and supported code comments from files, directories, strings, or stdin.
  • Enforce house style, spelling, capitalization, terminology, and readability checks through local configs, vocabularies, and downloadable style packages.
  • Emit JSON or line-based findings plus config, directory, and file-metric data for CI gates, editor integrations, and follow-up edits.
Agent Fit
  • --output=JSON, stdin support, and tested 0/1/2 exit behavior make parse-edit-rerun loops straightforward.
  • Repo-local .vale.ini files and style packages fit skill-based workflows well: an agent can inspect the config, run sync, lint changed files, and verify documentation edits with the same rules used in CI.
  • Most value is in detection, not remediation; Vale usually reports issues for a human or agent to rewrite rather than fixing prose automatically.
Caveats
  • Useful results depend on a project config and styles or vocabulary; first-run setup may require checked-in rules or a vale sync step.
  • If teams rely on custom templates instead of JSON or line output, follow-up parsing becomes more workflow-specific.