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"。本文只整理仓库能直接核验的内容,不把星标、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 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"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),。