Usage

An introduction to Vale, a syntax-aware linter for prose built with speed and extensibility in mind.

CLI

At its core, Vale is designed to be used as a command-line tool. Its general usage information is given below:

$ vale --help
NAME:
   vale - A command-line linter for prose.

USAGE:
   vale [global options] command [command options] [arguments...]

VERSION:
   vx.x.x

COMMANDS:
     dump-config, dc  Dumps configuration options to stdout and exits
     new              Generates a template for the given extension point
     help, h          Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --glob value     a glob pattern (e.g., --glob='*.{md,txt}') (default: "*")
   --config value   a file path (e.g., --config='some/file/path')
   --output value   output style ("line" or "JSON") (default: "CLI")
   --ext value      extension to associate with stdin (default: ".txt")
   --no-wrap        don't wrap CLI output
   --no-exit        don't return a nonzero exit code on lint errors
   --sort           sort files by their name in output
   --normalize      replace each path separator with a slash ('/')
   --ignore-syntax  lint all files line-by-line
   --relative       return relative paths
   --help, -h       show help
   --version, -v    print the version

Vale’s --glob argument accepts the standard syntax. Additionally, any pattern prefixed with an ! will be nagated—e.g.,

$ vale --glob='!*.bin' directory  # Exclude all xxx.bin files