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.
If you want to lint the contents of a GitHub repository, the recommended approach is to use Vale's official GitHub Action.
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
$ curl -sfL https://install.goreleaser.com/github.com/ValeLint/vale.sh | sh -s vX.Y.Z$ export PATH="./bin:$PATH"$ vale -v
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.
Vale can also be used locally by a single writer through the command line or a third-party integration.
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.
Vale can be installed for local usage. To install the CLI, use one of the following options:
Download an executable from the releases page.
Pull the latest Docker image.
Use one of the available package managers: