Skip to content

Getting Started

About

Heads up!

This documentation is for v1 of Vale. Check out the v2 docs at https://errata-ai.gitbook.io/vale/!

Vale is a cross-platform (macOS, Windows, and Linux),command-line linter for prose built with speed and extensibility in mind.

Unlike most writing-related software, Vale's primary purpose isn't to provide its own advice; it's designed to enforce an existing style guide through its YAML-based 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.

Vale Screenshot

Installation

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

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, etc.) across multiple writers.

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

Using Vale with GitHub

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
where vX.Y.Z is your version of choice from the releases page.

Local use by a single writer

Vale can also be used locally by a single writer through their 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.

It also offers seamless integration with LanguageTool, providing access to over 2,000 English grammar rules.

Using Vale from the command line

Vale can be installed for local usage by downloading an executable from the releases page or by pulling the latest Docker container.