Installation

Vale offers multiple options for installation, each of which best suits a particular use case.

Heads up: Our documentation has moved -- you can find the new docs at https://docs.errata.ai/vale/install

Remote, collaborative use

One of Vale's strengths is its ability to help a company, project, or organization maintain consistency (capitalization styles, word choice, brand terminology, spelling, etc.) across multiple writers.

The benefits of these installation methods are that every writer has access to the same Vale configuration without having to install and configure the tool themselves.

Using Vale with GitHub

Example Vale output using GitHub's annotations UI

If you want to lint the contents of a GitHub repository, the recommended approach is to use Vale's official GitHub Action.

Using Vale with a continuous integration (CI) service

If you want to use Vale with a CI service such as Travis CI, CircleCI, or Jenkins, the recommended approach is to use Vale's GoDownloader script (Vale will be installed to /bin/vale):

$ curl -sfL https://install.goreleaser.com/github.com/ValeLint/vale.sh | sh -s vX.Y.Z
$ export PATH="./bin:$PATH"
$ vale -v

where vX.Y.Z is your version of choice from the releases page. This will ensure that your CI builds are consistent and allow you to update versions on an opt-in basis.

Local use by a single writer

Vale can also be used locally by a single writer through the command line or a third-party integration.

Using Vale with a text editor (or another third-party application)

Vale has a commercial desktop application, Vale Server, that integrates with many third-party applications (including Atom, Sublime Text, VS Code, and Google Docs) and allows writers to easily create and switch between multiple local Vale configurations.

Sublime Text
VS Code
Atom
Google Docs
Chrome
Sublime Text
Vale Server's Sublime Text plugin
VS Code
Vale Server's VS Code extension
Atom
Vale Server's Atom plugin
Google Docs
Vale Server's Google Docs add-on
Chrome
Vale Server's Chrome add-on

Using Vale from the command line

Vale can be installed for local usage. To install the CLI, use one of the following options: