/usr/bin/vale

vale - A command-line linter for prose.

Usage:	vale [options] [input...]
	vale myfile.md myfile1.md mydir1
	vale --output=JSON [input...]

Vale is a syntax-aware linter for prose built with speed and extensibility in
mind. It supports Markdown, AsciiDoc, reStructuredText, HTML, and more.

To get started, you'll need a configuration file (.vale.ini):

Example:

	MinAlertLevel = suggestion

	[*]
	BasedOnStyles = Vale

See https://vale.sh for more setup information.

Flags:

 --config         A file path (--config='some/file/path/.vale.ini').
 --output         An output style ("line", "JSON", or a template file).
 --minAlertLevel  The minimum level to display (--minAlertLevel=error).
 --glob           A glob pattern (--glob='*.{md,txt}').
 --filter         An expression to filter rules by.
 -h, --help       Print this help message.
 -v, --version    Print the current version.


More flags:

 --coverage        With `vale test`: fail when a rule produced no alert in any case.
 --ext             An extension to associate with stdin (--ext=.md).
 --ignore-syntax   Lint all files line-by-line.
 --no-color        Don't colorize CLI output.
 --no-exit         Don't return a nonzero exit code on errors.
 --no-global       Don't load the global configuration.
 --no-wrap         Don't wrap CLI output.
 --path            A file path to associate with stdin (--path=docs/example.md).
 --plain-progress  Log each step instead of drawing a progress bar.


Commands:

 ls-config   Print the current configuration to stdout.
 ls-dirs     Print the default configuration directories to stdout.
 ls-metrics  Print the given file's internal metrics to stdout.
 ls-vars     Print the supported environment variables to stdout.
 sync        Download and install external configuration sources.
 test        Run the test cases kept beside a configuration's rules.

Run vale <command> --help for a command's own help.