CLI
Learn about the Vale command-line interface.
The Vale CLI is a powerful tool for linting your content in a variety of formats. To get started, try running with no arguments:
The following list of environment variables are supported by the vale command-line interface:
VALE_CONFIG_PATH
Override the default search process by specifying a .vale.ini file.
VALE_STYLES_PATH
Specify the location of the default StylesPath.
You can inspect the current environment variables by running:
The exact steps for setting environment variables depend on your operating system, but here are some useful links for Windows and macOS.
sync
Download and install packages. See Packages for more information.
<br>$ vale sync<br>
ls-config
Print the current configuration options as JSON.
<br>$ vale ls-config<br>
ls-metrics
Print the computed metrics for the given file. See metric for more information.
<br>$ vale ls-metrics path/to/file<br>
ls-dirs
Print the location of default configuration directories.
<br>$ vale ls-dirs<br>
ls-vars
Print the supported environment variables.
<br>$ vale ls-vars<br>
--config
Override the default configuration search process.
<br>$ vale --config='path/to/.vale.ini' README.md<br>
--ext
Assign a file extension to stdin. ``` $ echo "This is Markdown"
--filter
An expression to filter rules by. See Filters for more information.
<br>$ vale --filter='"heading" in .Scope' test.md<br>
--glob
A glob pattern to match files against. See Globbing for more information.
<br>$ vale --glob='*.md' some-dir<br>
--ignore-syntax
Treat all input as plain text.
<br>$ vale --ignore-syntax README.md<br>
--no-exit
Do not return a non-zero exit code if there are errors.
<br>$ vale --no-exit README.md<br>
--no-wrap
Do not wrap output.
<br>$ vale --no-wrap README.md<br>
--no-global
Do not load the global configuration.
<br>$ vale --no-global README.md<br>
--output
Change the output format. See Templates for more information.
<br>$ vale --output=JSON README.md<br>
--version
Print the version of Vale.
<br>$ vale --version<br>
The vale CLI returns the following exit codes:
0
No error(s) were found.
1
Linting error(s) were found. Useful for failing CI builds; can be disabled with --no-exit.
2
Runtime error(s) occurred.
It will try to respect the value of --output when printing to stderr. For example:
