Repolode
intellectronica

intellectronica/ruler

一个命令行工具,把 AI 编程助手的指令集中维护在 .ruler/ 目录,并自动生成各代理所需的配置文件。

Star
2,962
Fork
166
未关闭 Issue
21
最近提交
3天前

这是什么?

Ruler 解决的问题是:同一套编码规范要分别写进多个 AI 编程助手各自的配置文件里,比如 CLAUDE.md、Cursor 规则或 .clinerules。你只需把指令以 Markdown 形式写在 .ruler/ 目录下,运行 ruler apply,它就会把内容分发到每个受支持代理读取的配置文件中。

除规则文件外,Ruler 还能在 ruler.toml 中定义 MCP 服务器,并写入各代理原生的 MCP 配置;对支持的代理,也会同步 skills 与 subagents。它会自动更新 .gitignore,让生成的文件不进入版本控制,并在覆盖前创建备份,ruler revert 可以恢复原始文件。

项目还提供实验性的嵌套模式,可在 monorepo 中发现多个 .ruler/ 目录,让不同子模块使用各自的规则。项目以 @intellectronica/ruler 发布到 npm,需要 Node.js 20.19 或更高版本。

核心功能

  • 01所有代理指令以 Markdown 形式集中存放在 .ruler/ 目录中。
  • 02为 Claude Code、Cursor、Copilot、Codex CLI、Windsurf 等 30 多款代理生成规则文件。
  • 03将 ruler.toml 中定义的 MCP 服务器写入各代理原生的 MCP 配置。
  • 04自动更新 .gitignore 忽略生成文件,并创建 .bak 备份。
  • 05提供 ruler revert 命令,撤销 apply 所做的更改。
  • 06为 monorepo 提供实验性的嵌套规则加载。

适用场景

  • 团队同时使用 Claude Code 和 Cursor,希望两者遵循相同的编码规范。
  • 开发者使用不同 AI 助手时,统一维护同一套项目约定。
  • 前端、后端、测试等子目录需要不同代理指令的 monorepo。
  • 无需逐一手动编辑,就能把共享的 MCP 服务器配置分发给多个编程代理。

快速上手

  1. 1

    通过 npm 全局安装 Ruler

    npm install -g @intellectronica/ruler
  2. 2

    进入项目根目录并初始化 .ruler/ 目录

    ruler init
  3. 3

    编辑 .ruler/ 中的规则文件,然后生成各 AI 代理的配置文件

    ruler apply

使用前须知

  • 需要 Node.js ^20.19.0、^22.12.0 或 >=23 版本。
  • 目前处于 Beta 研究预览阶段,行为可能会变化。
  • 嵌套规则加载功能为实验性功能,未来版本可能会更改。

收录于专题

标签

常见问题

ruler 是什么?
一个命令行工具,把 AI 编程助手的指令集中维护在 .ruler/ 目录,并自动生成各代理所需的配置文件。 Ruler 解决的问题是:同一套编码规范要分别写进多个 AI 编程助手各自的配置文件里,比如 CLAUDE.md、Cursor 规则或 .clinerules。你只需把指令以 Markdown 形式写在 .ruler/ 目录下,运行 ruler apply,它就会把内容分发到每个受支持代理读取的配置文件中。
ruler 可以免费使用吗?用的什么许可证?
ruler 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
ruler 还在维护吗?
活跃维护中。ruler 最近一次提交是在 2026年11月4日。
ruler 适合用来做什么?
团队同时使用 Claude Code 和 Cursor,希望两者遵循相同的编码规范。 开发者使用不同 AI 助手时,统一维护同一套项目约定。 前端、后端、测试等子目录需要不同代理指令的 monorepo。 无需逐一手动编辑,就能把共享的 MCP 服务器配置分发给多个编程代理。
ruler 怎么安装和运行?
通过 npm 全局安装 Ruler: npm install -g @intellectronica/ruler 进入项目根目录并初始化 .ruler/ 目录: ruler init 编辑 .ruler/ 中的规则文件,然后生成各 AI 代理的配置文件: ruler apply
在哪里获取 ruler?
源代码和安装说明在 GitHub 上:https://github.com/intellectronica/ruler

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

相关项目