code-graph

Code Graph 技能

你负责完整的 cgraph 生命周期：数据库、索引和查询。用户不应需要手动运行 cgraph 命令。

管理规则

• 如果 cgraph 命令因连接错误而失败，请先运行 cgraph ensure-db。
• 如果找不到 cgraph，请参阅 management.md 中的安装说明。
• 在会话开始时或代码有重大更改后建立索引：cgraph index . --ignore node_modules --ignore venv --ignore .git --ignore __pycache__
• 如果代码没有更改，连续查询之间无需重新建立索引。
• 所有命令输出均为 stdout 上的 JSON。状态和进度信息写入 stderr。
• 如果省略 --repo，默认使用当前目录名称。

建立索引

# Index the current project
cgraph index . --ignore node_modules --ignore venv --ignore .git --ignore __pycache__

# Index a specific folder with a custom name
cgraph index /path/to/project --repo my-project --ignore node_modules

# Clone and index a remote repository
cgraph index-repo https://github.com/org/repo --ignore node_modules

搜索

# Search for entities by prefix
cgraph search get_user
cgraph search parse
cgraph search MyClass

结果以 JSON 格式返回，包含节点的 id、labels（File、Class、Function 等）和 properties（name、path、src_start、src_end）。后续查询请使用 id。

探索关系

# Get all neighbors of a node
cgraph neighbors 42 --repo my-project

# Filter by relationship type
cgraph neighbors 42 --rel CALLS          # what does it call?
cgraph neighbors 42 --rel DEFINES         # what does it define?

# Filter by destination label
cgraph neighbors 42 --label Function      # only function neighbors

# Multiple nodes at once
cgraph neighbors 42 55 --repo my-project

查找路径

# Trace call-chain paths between two nodes
cgraph paths 42 99 --repo my-project

沿着 CALLS 边查找一个函数如何到达另一个函数。

仓库信息

# List all indexed repos
cgraph list

# Show stats for a repo
cgraph info --repo my-project

使用结果

• 搜索结果包含 path、src_start、src_end — 使用 Read 工具加载这些位置上的实际源代码。
• 节点标签：File、Class、Function、Interface、Struct
• 边类型：DEFINES（层级关系）、CALLS（调用图）、EXTENDS（继承）、IMPLEMENTS（接口）、RETURNS（返回类型）、PARAMETERS（参数类型）
• 有关详细的 JSON 结构和常见查询模式，请参阅 querying.md。