项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-11-06 · 当前星标 ★ 76770
使用教程
环境要求
- 能运行 npx 的终端环境(Quick Start 用 npx 运行安装器)
- 支持的 AI 编程助手之一,如 Claude Code、Cursor、Codex CLI、Gemini CLI、GitHub Copilot 等
- 如需在自己的 Node 进程中嵌入库用法,需 Node 22.5+(CLI 与 MCP 服务使用自带运行时,不受此限制)
- 本地待索引的项目代码目录
安装与启动步骤
-
1运行安装器
在终端执行交互式安装器,它会自动检测本机已安装的智能体并询问配置项。
npx @colbymchenry/codegraph -
2按提示选择智能体
依次选择要接入的智能体、是否把 codegraph 装到 PATH、配置作用于全局还是当前项目。
-
3非交互安装
脚本或 CI 场景可用参数跳过交互,用 --target 指定智能体列表。
codegraph install --yes codegraph install --target=cursor,claude --yes codegraph install --yes --init -
4为项目建索引
安装器只写智能体配置、不索引代码;每个项目需单独执行一次初始化生成索引。
codegraph init -
5查看配置片段
只打印某个智能体的 MCP 配置片段、不写文件,便于核对接入内容。
codegraph install --print-config codex -
6卸载与升级
卸载会先列出所有已安装形态再删除;--keep-cli 只清智能体配置。项目索引用 uninit 清理。
codegraph upgrade codegraph uninstall --keep-cli codegraph uninit
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
exclude | 否 | 排除已提交但不想索引的目录,gitignore 风格,按仓库根相对路径匹配 | {"exclude": ["static/", "**/vendor/**"]} |
include | 否 | 强制把被 .gitignore 排除的真实源码纳入索引,显式 exclude 仍优先 | {"include": ["Tools/", "Local/typescript/"]} |
如何确认成功
安装器完成后,运行 codegraph init 能正常建索引并生成项目下的 .codegraph/ 目录,且所选智能体的配置中出现 CodeGraph 的 MCP 条目。
常见问题
Q:安装后智能体还是不懂我的项目?
A:安装器只配置智能体、不索引代码。需在每个项目目录执行一次 codegraph init,或用 codegraph install --yes --init 一次性引导。
Q:必须装 Node.js 吗?
A:Quick Start 用 npx 运行安装器,需要可执行 npx 的环境;嵌入库用法要求 Node 22.5+,CLI 与 MCP 服务使用自带运行时。
Q:node_modules、dist 会被索引吗?
A:默认跳过依赖、构建与缓存目录及 .gitignore 内容,还有超过 1MB 的文件。想收回某个目录可用 !vendor/ 或 codegraph.json 的 include。
Q:只想移除智能体配置、保留命令行?
A:执行 codegraph uninstall --keep-cli,只清各智能体的 MCP 配置、指令和权限,保留 CLI 本体。
Q:项目里的 .codegraph 索引怎么删?
A:卸载不会动项目索引,需在项目目录执行 codegraph uninit 单独清理。
注意事项
- 安装器会询问是否把 codegraph 加入 PATH,智能体启动 MCP 服务依赖它,建议选是。
- 索引与查询全部在本地完成,代码不上传,适合隐私敏感或大型仓库。
- 配置文件 codegraph.json 为可选项,仅用于自定义扩展名或排除/包含目录,默认零配置。
- 已安装的用户可用 codegraph upgrade 升级到新版本。
核心亮点
- 预索引加变更自动同步,智能体不必每次全量扫描仓库
- 覆盖 Claude Code、Cursor、Codex 等主流 AI 编程工具,接入面广
- 索引与查询全本地运行,代码不出本机
不足之处
- 索引大型仓库的初次构建耗时与内存占用需实际验证
- 对非 TypeScript 技术栈的解析深度和覆盖度待观察
适用场景
- 在数十万行代码的仓库中让 AI 助手快速定位相关模块
- 多人协作时随提交自动更新索引,保持上下文新鲜
- 对代码隐私敏感、不能上传云端索引的团队本地使用
替代项目
Sourcegraph、tree-sitter、Serena
上一篇:copilot
下一篇:没有了!
同类项目推荐
rtl-for-vs-code-agents
开源
让阿拉伯语/希伯来语开发者用 Copilot 时文字和代码都不乱
Native-like RTL support for VS Code AI Agents (i.e. GitHub Copilot) with proper LTR ···
power-platform-skills
开源
让 AI 助手直接会写 Power Platform 方案
A plugin marketplace for GitHub Copilot and other AI agents that provides Power Plat···
ai-code-interface.el
开源
在 Emacs 里统一调用各家 AI 编码 CLI,不切终端
Unified Emacs interface supporting OpenAI Codex, Antigravity CLI, Claude Code, Pi ag···
claude-code-plus
开源
在 JetBrains 里给 AI 编程助手装上图形界面,告别黑窗口
️ GUI Plugin for Claude Code / Codex CLI / Gemini CLI in JetBrains IDEs - Run AI co···
claude-code-ultimate-guide
开源
学透Claude Code,从入门到生产级实战
The most comprehensive Claude Code guide: agentic workflows, hooks, skills, MCP serv···
PyGen
开源
说句话,自动生成 Python 包,省去手写结构。
Generate Python Package with Simple Prompts
cc-pocket
开源
手机远程操控 Claude/Codex,随时续跑会话、审批权限
Pairlet (formerly CC Pocket / cc-pocket) — Continue your local AI coding tasks from···
llm-skills
开源
一套技能,多个 AI 编码助手通用,省去重复配置
Shared skills for AI coding assistants (Claude Code, Codex, etc.)
zclean
开源
一键清理 AI 编程工具缓存,让工作区干净安全
AI coding runtime hygiene for Codex, Claude Code, Cursor, Windsurf, MCP servers, and···
