dyoshikawa/rulesync

A Utility CLI for AI Coding Agents

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;未添加任何外部假設。

相關

  • 專案
  • 專案
  • 專案
  • 專案
  • 專案