Forrest logo
tool overview
On this page you find all important commands for the CLI tool vale. If the command you are looking for is missing please ask our AI.

vale

Vale is a command line tool that allows developers to lint and style-check their writing, specifically aimed at checking documentation and prose. It helps maintain a consistent writing style across projects and teams.

It supports multiple markup languages such as Markdown, reStructuredText, AsciiDoc, and plain text files. It utilizes a plugin-based architecture, allowing users to extend its functionality with custom rules.

Vale uses a configurable set of rules to check for issues like grammar, style, usage, and more. It provides detailed messages for each error, guiding users on how to rectify them.

Vale supports exclusion and inclusion syntax to selectively run rules on specific sections or files. It also allows users to create custom configurations to customize the tool's behavior as per their project or organization's style guide.

It has a watch mode that can continuously monitor files and automatically run checks upon changes. Additionally, Vale integrates well with popular code editors and Continuous Integration (CI) tools.

Vale's command line interface (CLI) is easy to use, and it supports various command line options and flags to control its behavior. Users can run it on specific files, directories, or even entire code repositories.

The tool is maintained actively with regular updates and bug fixes. It has a growing community of contributors who offer support and share custom rules and plugins.

Vale is open-source and can be installed via package managers such as Homebrew, npm, or pip, making it easily accessible to developers across different platforms.

It has cross-platform compatibility and can be used on Windows, macOS, and Linux.

Vale promotes consistent and high-quality writing, making it a valuable tool for developers, technical writers, and anyone who wants to improve the clarity and readability of their text-based documentation.

List of commands for vale:

  • vale:tldr:37109 vale: Output the results in JSON format.
    $ vale --output=JSON ${filename}
    try on your machine
    explain this command
  • vale:tldr:3f66f vale: List the current configuration.
    $ vale ls-config
    try on your machine
    explain this command
  • vale:tldr:55738 vale: Check the style of a file.
    $ vale ${filename}
    try on your machine
    explain this command
  • vale:tldr:dcc76 vale: Check the style of a file with a specified configuration.
    $ vale --config='${path-to--vale-ini}' ${filename}
    try on your machine
    explain this command
  • vale:tldr:f1209 vale: Check style issues at the specific severity and higher.
    $ vale --minAlertLeve=${select} ${filename}
    try on your machine
    explain this command
tool overview