CodeGraph安装使用

CodeGraph安装使用

Linux：运行：

bash

cat > codegraph-guide.md << 'EOF'
（粘贴下面的内容）
EOF

# @optave/codegraph 安装与使用指南

## 一、安装

### 前置要求
- Node.js 18+（运行 `node --version` 确认）

### Linux
​```bash
sudo npm install -g @optave/codegraph

Windows

powershell

npm install -g @optave/codegraph

验证

bash

codegraph --version

---

二、构建项目图谱

bash

cd 你的项目目录
codegraph build

---

三、核心用法

1. 找入口（用搜索）

bash

# REST API
grep -r "@GetMapping\|@PostMapping" --include="*.java"

# 定时任务
grep -r "@Scheduled" --include="*.java"

# Kafka
grep -r "@KafkaListener" --include="*.java"

2. 追调用链（用 codegraph）

bash

codegraph trace_call_path --function "函数名" --direction outbound --depth 5
codegraph query "函数名"

3. 画时序图

bash

codegraph export --format mermaid --output 输出.mmd

4. 交互式可视化

bash

codegraph plot

---

四、与 Claude Code 集成

在 Claude Code 的 MCP 配置文件中添加：

json

{
  "mcpServers": {
    "codegraph": {
      "command": "codegraph",
      "args": ["mcp"]
    }
  }
}

配置文件位置：

• Linux: ~/.claude.json 或 ~/.config/claude/settings.json
• Windows: %APPDATA%\Claude\settings.json

重启 Claude Code 即可使用。

---

五、常用命令速查

命令	作用
codegraph build	构建图谱
codegraph watch	自动增量更新
codegraph query <函数名>	查调用关系
codegraph fn-impact <函数名>	查影响范围
codegraph trace_call_path	追踪调用链
codegraph map	看最热门的函数
codegraph export --format mermaid	导出时序图
codegraph plot	3D 可视化
codegraph mcp	启动 MCP 服务

---

六、多项目管理

每个项目独立执行 codegraph build，在各自目录下启动 Claude 即可自动隔离。

---

七、常见问题

问题	解决
codegraph 找不到	重启终端，或把 %AppData%\npm 加入 PATH
Node 版本过低	升级到 18+
构建卡住	尝试 codegraph build --no-incremental

---

八、许可证