Vale CLI is a style linter you can use to improve your writing style. Here’s a quick oveview: What is the Vale CLI style checker.
After you install Homebrew, which can be a little tricky, you install Vale CLI by running the brew install vale
command:
$ brew install vale ==> Downloading https://ghcr.io/v2/homebrew/core/vale/manifests/2.15.5 ######################################################################## 100.0% ==> Downloading https://ghcr.io/v2/homebrew/core/vale/blobs/sha256:8b2094cb8521d ==> Downloading from https://pkg-containers.githubusercontent.com/ghcr1/blobs/sh ######################################################################## 100.0% ==> Pouring vale--2.15.5.x86_64_linux.bottle.tar.gz 🍺 /home/linuxbrew/.linuxbrew/Cellar/vale/2.15.5: 5 files, 13.0MB ==> Running `brew cleanup vale`... Disable this behaviour by setting HOMEBREW_NO_INSTALL_CLEANUP. Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`).
That’s it! Pretty easy. You’re ready to start using Vale CLI with Markdown or HTML.
You also need to install a parser if you plan to use Vale CLI with the following markup formats:
- reStructuredText
- AsciiDoc
- DITA
- XML
- Code
For example, because I use Vale with Asciidoc markup, I install the asciidoctor parser:
$ brew install asciidoctor [...] ==> Installing dependencies for asciidoctor: libyaml and ruby [...] ==> Installing asciidoctor ==> Pouring asciidoctor--2.0.17.x86_64_linux.bottle.tar.gz 🍺 /home/linuxbrew/.linuxbrew/Cellar/asciidoctor/2.0.17: 3,059 files, 22.4MB ==> Running `brew cleanup asciidoctor`...