About Vale
Vale is a command-line tool that checks prose against rules you define, much like a code linter checks source files. It is written in Go and runs on macOS, Windows and Linux without needing a network connection.
What it does
You turn a style guide, a house voice or a terminology list into YAML rules. Vale then flags matches in Markdown, plain text and other files, and it can run in your editor or as a check in continuous integration. Rules can be written from scratch or taken from published styles such as Microsoft, Google and Red Hat.
Key features
- Rules written in YAML
- Published styles from Microsoft, Google and Red Hat
- Runs offline on macOS, Windows and Linux
- Feedback in editors and continuous integration
- Substitution rules for product names and terms
Who it's for
Technical writers, documentation teams and open source maintainers who want consistent wording across many pages. It suits organizations that want style checks to run on every change, the same way tests do.
Pricing and good to know
Vale is open source under the MIT license and is free to use. It is installed as a single command-line program, and it runs offline. The project is funded through sponsors and grants, including a grant from FLOSS/fund that its site lists. Rules take some time to write, although published styles give you a starting point.
Highlights
- Writes style rules in YAML files
- Uses published Microsoft, Google and Red Hat styles
- Runs offline on macOS, Windows and Linux
- Flags terms with substitution rules
- Integrates with editors and CI checks
