Repolode
提交项目
vale-cli

vale-cli/vale

一款命令行文本检查工具，把团队的写作规范转为检查规则，可在编辑器、CI 和代码中离线运行。

可替代:Grammarly

在 GitHub 查看官网
Star
6,278
Fork
236
未关闭 Issue
23
最近提交
6天前

这是什么？

Vale 是一款面向文本的命令行检查工具，可将团队的写作指南转化为自动化检查。它本身不带预设观点：团队可以选用 Microsoft、Google 等公开的风格指南，也可以加入自定义术语，或两者结合，然后对 Markdown、AsciiDoc、reStructuredText、HTML 等多种文档格式进行检查。

Vale 使用真实的解析器处理文档标记，规则可以针对标题、列表或表格单元格，并自动跳过代码片段、URL 和代码块。它还借助 tree-sitter 语法从源码中提取注释和文档字符串，并能检查 OpenAPI 描述、Notebook 单元格或提交信息等文件中的文字内容。

规则以 YAML 文件编写，从简单的词语替换到词性模式、可读性公式和脚本都能覆盖。部分规则自带修复建议，编辑器或 AI 代理可直接应用。Vale 使用 Go 编写，为单个二进制文件，支持 macOS、Windows 和 Linux，且完全离线运行。

核心功能

  • 01检查前先解析 Markdown、AsciiDoc、reStructuredText、HTML 等标记格式。
  • 02从源代码中提取注释和文档字符串进行检查。
  • 03规则以 YAML 编写，支持词语替换、词性匹配和可读性检查。
  • 04可通过一条命令同步 Microsoft、Google 等公开的风格包。
  • 05规则可附带自动修复，供编辑器或 AI 代理直接应用。
  • 06以单个 Go 二进制文件运行，支持 macOS、Windows 和 Linux，完全离线。

适用场景

  • 在技术文档中统一执行公司或项目的写作规范。
  • 检查术语不一致的问题，例如产品名称的写法。
  • 在 CI 中运行文本检查，自动验证文档的拉取请求。
  • 检查代码注释和文档字符串，与其所描述的代码一起维护。

快速上手

  1. 1

    在 macOS 上通过 Homebrew 安装 Vale

    brew install vale
  2. 2

    在项目根目录创建 .vale.ini 配置文件

  3. 3

    下载已配置的风格规则

    vale sync
  4. 4

    检查 README.md 等文件

    vale README.md

使用前须知

  • 部分平台的安装方式仅列出特定包管理器，其他系统需使用各自可用的包管理器。
  • Vale 主要由一位维护者开发，支持和开发进度依赖于此人。

收录于专题

命令行与终端工具

标签

#linter#documentation#prose#markdown#style-guide#cli#writing#ci#linting#vale

常见问题

vale 是什么？
一款命令行文本检查工具，把团队的写作规范转为检查规则，可在编辑器、CI 和代码中离线运行。 Vale 是一款面向文本的命令行检查工具，可将团队的写作指南转化为自动化检查。它本身不带预设观点：团队可以选用 Microsoft、Google 等公开的风格指南，也可以加入自定义术语，或两者结合，然后对 Markdown、AsciiDoc、reStructuredText、HTML 等多种文档格式进行检查。
vale 可以免费使用吗？用的什么许可证？
vale 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
vale 还在维护吗？
活跃维护中。vale 最近一次提交是在 2026年10月16日。
vale 适合用来做什么？
在技术文档中统一执行公司或项目的写作规范。 检查术语不一致的问题，例如产品名称的写法。 在 CI 中运行文本检查，自动验证文档的拉取请求。 检查代码注释和文档字符串，与其所描述的代码一起维护。
vale 怎么安装和运行？
在 macOS 上通过 Homebrew 安装 Vale: brew install vale 在项目根目录创建 .vale.ini 配置文件 下载已配置的风格规则: vale sync 检查 README.md 等文件: vale README.md
在哪里获取 vale？
源代码和安装说明在 GitHub 上：https://github.com/vale-cli/vale

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目