vale-cli/vale

O que é?

Recursos principais

• 01Analisa Markdown, AsciiDoc, reStructuredText, HTML e outros formatos de marcação antes de verificar o texto.
• 02Extrai comentários e docstrings do código-fonte para verificação.
• 03Regras escritas em YAML, de substituições de tokens a verificações de classes gramaticais e legibilidade.
• 04Inclui pacotes de estilo publicados, como os da Microsoft e do Google, que podem ser sincronizados com um único comando.
• 05As regras podem incluir correções automáticas para editores e agentes aplicarem.
• 06Funciona offline no macOS, Windows e Linux como um único binário Go.

Casos de uso

• Aplicar o guia de estilo de uma empresa ou projeto em toda a documentação técnica.
• Detectar inconsistências de terminologia, como variações nos nomes de produtos na documentação.
• Executar verificações de prosa no CI para validar automaticamente pull requests de documentação.
• Verificar docstrings e comentários no código junto com o código que eles descrevem.

Início rápido

1. 1

   Instale o Vale com Homebrew no macOS

   brew install vale
2. 2

   Crie um arquivo de configuração .vale.ini na raiz do projeto

3. 3

   Baixe os estilos configurados

   vale sync
4. 4

   Faça lint em um arquivo, como README.md

   vale README.md

Antes de usar

• !Para algumas plataformas, só é indicado o método de instalação com Go; para outras opções, é necessário usar o gerenciador de pacotes disponível no sistema.
• !O Vale é desenvolvido principalmente por uma única pessoa, então o suporte e a velocidade de desenvolvimento dependem dela.

Tópicos

Perguntas frequentes

O que é vale?

Um linter de prosa de linha de comando que aplica as regras de escrita da sua equipe em editores, no CI e no código, sem precisar de conexão com a internet. Vale é um linter de prosa que transforma diretrizes de escrita em verificações automatizadas. Ele não impõe um estilo próprio: as equipes podem escolher um guia de estilo publicado, como os da Microsoft ou do Google, adicionar seus próprios termos ou combinar as duas opções. Vale aplica essas regras a Markdown, AsciiDoc, reStructuredText, HTML e outros formatos de documento.

vale é gratuito? Qual é a licença?

vale é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.

vale ainda é mantido?

Manutenção ativa. O último commit de vale foi em 16 de out. de 2026.

Para que posso usar vale?

Aplicar o guia de estilo de uma empresa ou projeto em toda a documentação técnica. Detectar inconsistências de terminologia, como variações nos nomes de produtos na documentação. Executar verificações de prosa no CI para validar automaticamente pull requests de documentação. Verificar docstrings e comentários no código junto com o código que eles descrevem.

Como instalar vale?

Instale o Vale com Homebrew no macOS: brew install vale Crie um arquivo de configuração .vale.ini na raiz do projeto Baixe os estilos configurados: vale sync Faça lint em um arquivo, como README.md: vale README.md

Onde consigo vale?

O código-fonte e as instruções de instalação estão no GitHub: https://github.com/vale-cli/vale