code-index 是一个面向本地代码仓库的索引与知识图谱服务。它可以解析代码结构、建立可查询的图谱索引,并通过模型上下文协议服务或本地命令行提供检索、架构分析和调用路径追踪能力。
- 为本地仓库建立代码知识图谱索引。
- 通过模型上下文协议标准输入输出服务暴露核心工具。
- 查询项目列表、索引状态、图谱结构和架构概览。
- 搜索图谱、搜索代码、追踪调用路径、执行只读图查询。
- 检测代码变更影响。
- 管理架构决策记录。
- 导入运行时追踪数据。
- 读写共享图谱快照文件。
- 通过
cli <工具名> <参数>做本地单次工具调用。
code-index 专注于代码索引、图谱查询和模型上下文协议服务,不包含图形界面、网页前端、一键安装器或多平台分发包装。
在项目根目录运行:
make -f Makefile.cbm CC=gcc CXX=g++ cbm生成的服务程序位于 build/c/ 目录,具体文件名以构建输出为准。
下文用 <服务程序> 代指构建得到的可执行文件。
直接启动二进制时,它默认作为模型上下文协议服务运行,通过标准输入输出通信:
<服务程序>查看版本:
<服务程序> --version查看帮助:
<服务程序> --help单次调用工具:
Set-Content -LiteralPath args.json -Value '{"repo_path":"D:/my project/code-index","mode":"fast"}'
<服务程序> cli list_projects
<服务程序> cli index_repository --args-file args.jsoncode-index 提供以下模型上下文协议工具:
index_repositoryindex_statuslist_projectsdelete_projectsearch_graphsearch_codetrace_pathdetect_changesquery_graphget_graph_schemaget_code_snippetget_architecturemanage_adringest_traces
启用持久化索引时,项目会在被索引仓库中写入压缩后的知识图谱快照。这个文件适合团队共享,其他使用者可以用它跳过完整重建索引。
运行:
powershell -ExecutionPolicy Bypass -File scripts/verify-core.ps1脚本会检查:
- 核心源码是否存在。
- 图形界面引用是否残留。
- 安装和分发入口是否残留。
- 是否能完成构建、版本命令、索引烟测和架构查询烟测。