Skip to main content

Installation

Vale offers multiple options for installation, each of which best suits a particular use case. The quickest way to get started, though, is by using either Homebrew (macOS and Linux), Chocolatey (Windows), or Docker (any):

Heads up!

If you're using Vale with a markup format other than Markdown or HTML, you'll also need to install a parser.

$ brew install vale

You can also download and manually install an executable from the releases page.

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.