dyoshikawa/rulesync

Rulesync – AI 开发工具的统一配置生成器

是什么 – rulesync 是一个 Node.js 命令行工具，可让您为 AI 编码助手（Claude Code、GitHub Copilot、Cursor 等）使用的多个配置文件维护单一真实源。通过一组“规则”文件，您可以自动创建、导入、导出或转换每个支持工具所需的原生配置格式。

为何重要 – 每个 AI 助手都有其独特的 JSON/YAML/Markdown 布局，用于提示规则、忽略列表、命令快捷键、子代理、技能等。手动维护这些配置容易出错，且难以在项目间保持同步。Rulesync 抽象了这些差异，您只需编辑一个 .rulesync/ 树，然后让 CLI 为每个目标生成正确的文件。

主要功能

• 选择性生成 – rulesync generate --targets "*" --features "*" 可生成所有支持的文件，您也可以将列表缩小到特定工具或功能组。
• 导入 / 导出 – rulesync import --targets <tool> 将现有配置导入统一的 .rulesync/ 格式；rulesync fetch 可拉取官方“技能”包。
• 直接转换 – rulesync convert --from cursor --to copilot,claudecode 可在不编写中间 .rulesync/ 文件的情况下，将一个工具的配置转换为另一个工具的格式。
• 广泛工具支持 – 列出了 30 多个 AI 编码助手及相关标准，附有矩阵，标明每个工具支持的功能（规则、忽略/权限、MCP、命令、子代理、技能、钩子、权限、检查）。
• 弃用处理 – 如 ignore 功能正被 permissions 取代；旧工具（如 Roo Code）仍通过兼容性别名支持。
• 程序化 API – 除了 CLI，该包还导出了可在 Node 脚本中使用的函数（参见文档网站）。

安装

# 全局 npm 安装
npm install -g rulesync

# Homebrew（macOS / Linux）
brew tap dyoshikawa/rulesync https://github.com/dyoshikawa/rulesync
brew install rulesync

# 单二进制安装程序
curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash

典型工作流

# 初始化新项目
rulesync init

# 拉取官方技能包（推荐）
rulesync fetch dyoshikawa/rulesync

# 生成所有支持的配置文件
rulesync generate --targets "*" --features "*"

如果您已有特定工具的配置，请先导入：

rulesync import --targets claudecode   # 从 CLAUDE.md
rulesync import --targets cursor       # 从 .cursorrules

支持的工具 – README 包含详细表格；值得注意的条目包括 Claude Code、GitHub Copilot（CLI 与 UI）、Cursor、Google Antigravity（IDE 与 CLI）、Kiro（IDE 与 CLI），以及 Hermes、Factory Droid、AugmentCode 等众多新兴代理。每个工具可能仅支持九个功能列中的部分功能。

文档与帮助 – 完整参考、安装指南和各功能选项均托管于 https://rulesync.dyoshikawa.com/。项目还展示了 CI、npm 统计数据徽章，以及在社区“awesome-list”中的提及情况。

许可证 – MIT。

---

所有细节均直接取自仓库的 README；未添加任何外部假设。