macOS
- Homebrew
- Binary Download
The recommended method for macOS users:To upgrade Vale:
Homebrew installs Vale from the official formula repository and keeps it up to date with
brew upgrade.Linux
- Package Manager
- Binary Download
Debian/Ubuntu (apt)
Debian/Ubuntu (apt)
Download and install the
.deb package:Fedora/RHEL/CentOS (dnf/yum)
Fedora/RHEL/CentOS (dnf/yum)
Download and install the
.rpm package:Arch Linux (AUR)
Arch Linux (AUR)
Install from the Arch User Repository:
Snap
Snap
Install from the Snap Store:
Windows
- Chocolatey
- Scoop
- Binary Download
The recommended method for Windows users:To upgrade Vale:
Chocolatey automatically adds Vale to your PATH, making it available from any command prompt or PowerShell window.
Docker
Vale is available as a Docker image, ideal for CI/CD pipelines:Usage examples
Usage examples
Lint files in the current directory:Run with a custom config:CI/CD pipeline example (GitHub Actions):
The Docker image supports both
linux/amd64 and linux/arm64 platforms.Build from Source
If you prefer to build Vale yourself or need the latest development version:Install Go
Vale requires Go 1.21 or later. Download it from golang.org.
The build process uses CGO for spell checking functionality, so you’ll need a C compiler (GCC or Clang) installed on your system.
Verify Installation
After installing Vale, verify it’s working correctly:Environment Variables
Vale supports two environment variables for configuration:| Variable | Description | Example |
|---|---|---|
VALE_CONFIG_PATH | Override the default config file search | export VALE_CONFIG_PATH=/path/to/.vale.ini |
VALE_STYLES_PATH | Specify the default styles directory | export VALE_STYLES_PATH=~/.config/vale/styles |
These variables are useful in CI/CD environments where you want to control Vale’s configuration without modifying the filesystem structure.
Editor Integration
Once Vale is installed, you can integrate it with your favorite editor:VS Code
Install the Vale VSCode extension for real-time linting as you write.
Sublime Text
Install SublimeLinter-vale via Package Control.
Emacs
Use flycheck-vale for real-time checking.
Editor integrations require Vale to be installed and available in your PATH.
Next Steps
Now that Vale is installed, you’re ready to start linting:Quick Start
Set up your first Vale project in minutes.
Configuration
Learn about
.vale.ini and how to configure Vale.Styles
Explore pre-built styles or create your own.
CI Integration
Add Vale to your continuous integration pipeline.
Troubleshooting
Vale command not found
Vale command not found
If you get a “command not found” error after installation:
- Check your PATH: Ensure the Vale installation directory is in your PATH
- Restart your terminal: Some installations require a new shell session
- Verify the binary location: Run
which vale(Unix) orwhere vale(Windows)
Permission denied errors
Permission denied errors
If you encounter permission errors when running Vale:On macOS/Linux:On Windows: Run your terminal as Administrator or adjust the file permissions in the security settings.
SSL certificate errors with vale sync
SSL certificate errors with vale sync
If On macOS:
vale sync fails with SSL errors, your system may have outdated CA certificates:On Ubuntu/Debian: