一、安装（三种可选方式）
方式B：npm 全局安装（需 Node.js 环境）
npm i -g @colbymchenry/codegraph
方式C：零安装，临时运行（npx）
npx @colbymchenry/codegraph
二、配置 AI Agent（连接 MCP 服务器）
用于将 CodeGraph 集成到 Cursor、Claude 等 AI 编辑器/客户端，自动写入 MCP 配置
# 交互式安装，自动识别本地已装 AI Agent
codegraph install
# 非交互式（CI/自动化脚本，跳过确认）
codegraph install --yes
# 指定全局安装目标客户端
codegraph install --target=cursor,claude --yes
# 自动识别客户端，仅在当前项目本地安装
codegraph install --target=auto --location=local
# 仅输出 MCP 配置片段，不写入本地配置文件
codegraph install --print-config codex
三、项目初始化&索引管理
CodeGraph 通过 .codegraph/ 目录存储项目代码索引缓存
3.1 项目初始化
cd your-project
# 仅创建 .codegraph/ 目录，不生成索引
codegraph init
# 初始化并立刻构建完整索引（推荐）
codegraph init -i
codegraph init --index
3.2 索引构建与刷新
# 增量同步：仅更新修改/新增/删除文件，速度更快
codegraph sync
# 全量重新构建项目索引
codegraph index
# 强制覆盖重建索引（无视缓存）
codegraph index --force
# 静默执行，精简控制台输出
codegraph index --quiet
四、查询命令（代码结构、依赖、影响分析）
基础状态与文件查看
# 查看索引构建状态、文件/符号统计，可指定目录过滤
codegraph status [path]
# 展示项目文件树结构
# 支持参数：--format 输出格式 / --filter 文件过滤 / --max-depth 层级限制 / --json 输出JSON
codegraph files [path]
符号、调用链查询
# 全局搜索代码符号（函数、变量、类等）
# 参数：--kind 限定符号类型 / --limit 返回条数 / --json JSON输出
codegraph query <search>
# 查找所有调用目标函数/符号的代码位置
codegraph callers <symbol>
# 查找目标函数内部调用的所有子符号
codegraph callees <symbol>
# 深度分析修改某个符号带来的全项目影响范围
# --depth 控制递归分析深度
codegraph impact <symbol>
变更影响文件筛查（适配 Git）
# 手动指定变更文件，检索受影响的测试/业务文件
codegraph affected src/utils.ts src/api.ts
# 结合 Git diff，自动读取变更文件批量分析
git diff --name-only | codegraph affected --stdin
# 指定变更文件，同时过滤仅查看 e2e 目录相关影响
codegraph affected src/auth.ts --filter "e2e/*"
五、MCP 服务器启动（供AI Agent调用）
# 启动 MCP 服务，提供代码索引能力给 Claude / Cursor
codegraph serve --mcp
六、版本升级 CLI
# 自动升级到最新稳定版
codegraph upgrade
# 仅检测是否存在新版本，不执行升级
codegraph upgrade --check
# 指定版本号安装（降级/固定版本）
codegraph upgrade <version>
八、完整干净卸载（分三步，缺一不可）
步骤1：从 AI Agent 移除 MCP 配置
仅删除编辑器配置，不删除项目索引、不卸载CLI
# 交互式卸载全部已配置Agent
codegraph uninstall
# 指定目标客户端卸载
codegraph uninstall --target=claude,cursor
# 非交互式，跳过确认弹窗
codegraph uninstall --yes
步骤2：删除单个项目本地索引
仅删除当前项目 .codegraph/ 缓存目录，不影响全局CLI和Agent配置
cd your-project
# 带确认提示删除索引目录
codegraph uninit
# 强制删除，跳过确认
codegraph uninit --force
步骤3：卸载全局 codegraph CLI
npm 安装版本
npm uninstall -g @colbymchenry/codegraph
关键说明
codegraph uninstall：只清除AI客户端MCP配置codegraph uninit：只删除单个项目本地索引缓存- 完整清理必须按「移除Agent配置 → 删除项目索引 → 卸载CLI」三步执行