roam-code

本機程式碼庫智慧 CLI + 給 AI 編碼代理的 MCP 伺服器:SQLite 程式碼圖、28 種語言、287 個指令、246 個 MCP 工具、變更安全閘門、稽核證據、零 API 金鑰。

roam-code 是什麼?

本機程式碼庫智慧 CLI + 給 AI 編碼代理的 MCP 伺服器:SQLite 程式碼圖、28 種語言、287 個指令、246 個 MCP 工具、變更安全閘門、稽核證據、零 API 金鑰。

roam-code 概覽

這是什麼

roam-code 是一個本機程式碼智慧 CLI 與 MCP 伺服器,專為 AI 編碼代理程式設計。它提供可重複使用的 SQLite 程式碼圖譜、288 個指令(281 個標準指令 + 7 個別名)、259 個 MCP 工具(預設 core 預設組包含 17 個),並支援 28 種語言。它在您的機器上執行,免費且開源,本機分析無需帳號或 API 金鑰,也不會自動上傳原始碼或遙測資料。它提供變更安全閘門與稽核證據。

主要功能

  • 可重複使用的本機分析:查詢檔案與函式之間的索引連線、檢查偵測到的模式與建議的替代方案,或執行範圍限定的檢查。
  • 靜態檢查使用本機運算,不依賴模型呼叫或付費的 Roam API。
  • 當程式碼變更時,使用 roam index 重新整理索引。
  • 288 個指令分為 7 個類別(入門、日常工作流程、程式碼庫健康、架構、探索、報告與 CI、重構)。
  • MCP 伺服器提供 8 個可選預設組(core、review、refactor、debug、architecture、compliance、compile-curated、full)。
  • core 預設組包含 17 個工具:roam_alerts、roam_ask、roam_batch_search、roam_coupling、roam_dead_code、roam_deps、roam_diagnose_issue、roam_fetch_handle、roam_file_info、roam_grep、roam_metrics、roam_prepare_change、roam_search_symbol、roam_taint、roam_understand、roam_uses 與 roam_expand_toolset。
  • 不會自動上傳原始碼或遙測資料;本機分析無需帳號或 API 金鑰。

使用情境

  • 尋找起點:取得專案概覽、定義與索引連線。
  • 評估方法:檢查模式發現結果與來自演算法目錄的替代方案。
  • 檢查變更:執行影響分析、相關測試指引與已設定的檢查結果。
  • 追蹤相依性、比較方法,或確定變更需要哪些檢查。
  • 在出現缺陷或修補程式之前即可使用:代理程式使用工具;人員設定方向並決定最終交付內容。

快速開始

您需要 Python 3.10+ 與一個 Git 儲存庫。在 Linux、macOS 或 Windows 上: bash pip install 'roam-code[mcp]' cd path/to/your/repo roam init init 會建立本機索引與專案設定;如果只需要索引,請使用 roam index。首次執行可能會下載解析器,所需時間比重新整理更長。 自行檢查第一個結果: bash roam health roam preflight 將 `` 替換為您專案中的函式或類別;使用 roam search 尋找。

授權與價格

採用 Apache-2.0 授權。免費且開源。

內容整理自該專案公開的 README 與儲存庫資訊。

將此徽章加入你的 README

Featured on YunoDB 徽章樣式與說明

你是這個專案的維護者嗎?展示它已收錄於 YunoDB。

Markdown[![Featured on YunoDB](https://yunodb.com/badge/cranotroam-code.svg)](https://yunodb.com/tools/cranotroam-code?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/cranotroam-code?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/cranotroam-code.svg" alt="Featured on YunoDB" height="20"></a>