colbymchenry/codegraph:README 來源編輯指南
根據 README、倉庫資料與授權整理 colbymchenry/codegraph 的安裝與核驗路徑。
專案定位
colbymchenry/codegraph 的 README 將專案描述為「Pre-indexed code knowledge graph, auto syncs on code changes, for Claude Code, Codex, Gemini, Cursor, OpenCode, AntiGravity, Kiro, and Hermes Agent , fewer tokens, fewer tool calls, 100% local」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「Supercharge Claude Code, Cursor, Codex, OpenCode, Hermes Agent, Gemini, Antigravity, and Kiro with Semantic Code Intelligence」下寫到:The fastest complete code graph · surgical context · built for how agents actually work · 100% local。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Built for speed , the Rust kernel」與相關條目,可以先判斷它是否處理你的實際問題:On a 2-core / 6GB VPS: the same graph, from a pipeline tuned to finish , the Linux kernel (70k files, 2M symbols, 6.4M relationships) indexes to completion in under 12 minutes where RAM-first designs run out of memory before reaching 1%.。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:On a workstation: the full parallel pipeline , native parse workers, a multi-worker resolver pool that engages the moment it pays for itself, memory-gated analysis caches.。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「1. Install the CLI」等段落。可確認的線索包括:No Node.js required , one command grabs the right build for your OS:。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: # macOS / Linux curl -fsSL https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.sh | sh # Windows (PowerShell) irm https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.ps1 | iex 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Supercharge Claude Code, Cursor, Codex, OpenCode, Hermes Agent, Gemini, Antigravity, and Kiro with Semantic Code Intelligence」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「2. Wire up your agent(s)」段落提到:In a new terminal, run the installer to connect CodeGraph to the agents you use:。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Every day after day one: saving a file updates the graph in well under a second , the watcher fires 300ms after a lone save and syncs exactly what changed (0.3s of work on a 4,400-file project, 0.4s on the 27,000-file Swift compiler repo),。