一款 Node.js CLI 工具,从统一的 AI 规则文件自动生成 20+ 款 AI 开发工具(Claude Code、Cursor、GitHub Copilot、Gemini CLI 等)的配置文件,实现"一次编写,多处分发",支持 MCP、commands、subagents、skills 等特性。
Rulesync 是一款解决多 AI 编码助手规则碎片化问题的 CLI 工具。在 Claude Code、Cursor、GitHub Copilot、Gemini CLI 等工具并存的开发环境中,团队往往需要在不同工具间重复编写指令和规则,维护成本高且易不一致。
核心价值#
- Single Source of Truth: 在
.rulesync/目录统一管理规则,自动转换为各工具原生格式 - 工具自由: 开发者可自由选择 AI 助手,无需重写团队标准
- 一致性保证: 新成员立即获得相同的约定、上下文和护栏
- 可审计输出: 生成纯配置文件,可提交、审查和发布
支持工具矩阵#
支持 20+ 款 AI 开发工具的配置生成:Claude Code、Cursor、GitHub Copilot、Gemini CLI、Codex CLI、Cline、OpenCode、Kiro、Windsurf、Zed 等。
| 特性 | 说明 |
|---|---|
| rules | 规则/指令配置 |
| ignore | 忽略文件配置 |
| mcp | Model Context Protocol 配置 |
| commands | 自定义命令 |
| subagents | 子代理配置 |
| skills | 技能定义 |
| hooks | 钩子配置 |
主要功能#
- 项目级与全局级双模式
- 从现有配置逆向导入(
rulesync import) - CI/CD 集成(
--check模式) - Dry-run 预览(
--dry-run) - 选择性生成(
--targets/--features)
安装与快速开始#
# 安装
npm install -g rulesync
# 初始化项目
rulesync init
# 安装官方 skills
rulesync fetch dyoshikawa/rulesync --features skills
# 生成所有工具配置
rulesync generate --targets "*" --features "*"
从现有配置导入#
rulesync import --targets claudecode # 从 CLAUDE.md
rulesync import --targets cursor # 从 .cursorrules
rulesync import --targets copilot # 从 .github/copilot-instructions.md
常用命令#
| 命令 | 功能 |
|---|---|
rulesync init | 初始化新项目 |
rulesync generate | 生成目标工具配置 |
rulesync import | 从现有配置导入 |
rulesync fetch | 安装远程 skills |
rulesync gitignore | 添加生成文件到 .gitignore |
实现要点#
- 语言: TypeScript (98.8%)
- 运行时: Node.js / Bun
- 包管理: pnpm
- 测试: Vitest
- 文档: VitePress