dyoshikawa/rulesync:README 來源編輯指南
根據 README、倉庫資料與授權整理 dyoshikawa/rulesync 的安裝與核驗路徑。
專案定位
dyoshikawa/rulesync 的 README 將專案描述為「A Utility CLI for AI Coding Agents」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「Rulesync」下寫到:A Node.js CLI tool that automatically generates configuration files for various AI development tools from unified AI rule files. Features selective generation, comprehensive import/export capabilities, and supports major AI development。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Target and deprecation notes」與相關條目,可以先判斷它是否處理你的實際問題:Ignore feature , The ignore feature is deprecated in favor of the more expressive permissions feature. Existing ignore configurations remain supported throughout Rulesync 14.x;。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:⚠️: Deprecated , still supported, but see the note below。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Installation」等段落。可確認的線索包括:Or install from our Homebrew tap (macOS and Linux):。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: npm install -g rulesync 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Installation」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Installation」段落提到:The tap lives inside this repository, so it does not have a homebrew- prefix. The two-argument brew tap form is therefore required , the shorthand brew install dyoshikawa/rulesync/rulesync without tapping first does not work.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Google Antigravity (antigravity-ide / antigravity-cli) , Antigravity 2.0 splits into two products with separate global config trees: the desktop antigravity-ide and the antigravity-cli (agy).。