Getting Started

An introduction to Vale, a syntax-aware linter for prose built with speed and extensibility in mind.

Introduction

Vale is a free, open-source linter for prose built with speed and extensibility in mind.

Unlike most writing aids, Vale’s primary purpose isn’t to provide its own advice; it’s designed to enforce an existing style guide through its easy-to-use extension system.

No matter if you’re working with a small in-house standard or a large editorial style guide, Vale will help you maintain consistent and error-free writing.

Installation

Vale runs on Windows, macOS, and Linux. It can be installed via one of the package managers listed below or manually by downloading an executable from the releases page.

brew tap ValeLint/vale brew install vale go get github.com/errata-ai/vale choco install vale snap install --edge vale

Support

Vale is actively maintained. If you run into any problems, please open an issue on GitHub or contact us via email.