rulesync

环境要求

• Node.js 环境（用于 npm 全局安装）
• macOS 或 Linux（使用 Homebrew 安装方式时）
• 可访问 npm 源与 GitHub Releases（下载安装脚本）

安装与启动步骤

1. 1npm 全局安装

   README 首选安装方式，通过 npm 将 rulesync 安装为全局命令行工具，安装后可在任意目录调用 rulesync 命令。

   npm install -g rulesync

   复制

2. 2Homebrew 安装替代

   macOS/Linux 用户也可用 Homebrew 安装。必须先执行两参数的 brew tap，再用 brew install 安装。

   brew tap dyoshikawa/rulesync https://github.com/dyoshikawa/rulesync
   brew install rulesync

   复制

3. 3单二进制安装

   不想用包管理器时，可执行官方安装脚本下载最新 Release 的单文件二进制版本。

   curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash

   复制

4. 4初始化项目

   在项目根目录执行，创建必要目录、示例规则文件和配置文件，是后续生成配置的基础。

   rulesync init

   复制

5. 5拉取官方技能

   README 推荐的步骤，从官方仓库获取官方 skills 到本地，供后续生成时使用。

   rulesync fetch dyoshikawa/rulesync

   复制

6. 6生成代理配置

   用通配符一次性为所有支持的目标工具和全部功能生成统一配置，如规则、命令、MCP、忽略文件等。

   rulesync generate --targets "*" --features "*"

   复制

如何确认成功

执行 rulesync generate 后，项目目录中出现对应 AI 开发工具的规则/配置文件即视为生成成功。

常见问题

注意事项

• Homebrew 安装必须使用两参数形式的 brew tap，不能用简写命令。
• 单二进制安装脚本从 GitHub Releases 拉取最新版本，需要网络可访问 GitHub。
• 更多手动安装及各平台细节请查阅官方安装文档 https://rulesync.dyoshikawa.com/getting-started/installation。