Relay Knowledge CLI

🔍 本地 GraphRAG 代码图谱查询引擎

基于本地 CLI 的代码仓库知识图谱与 GraphRAG 查询引擎,支持符号检索、调用链分析、依赖图谱及智能索引管理

收藏
5.3k
安装
1.2k
版本
1.1.10
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心功能

Relay Knowledge CLI 是一款专为代码仓库设计的本地知识图谱与 GraphRAG(图检索增强生成)工具,通过编译后的原生二进制文件提供高性能的代码语义查询能力。核心功能围绕仓库知识图谱构建多维度代码检索展开,支持从符号定义、引用关系到软件架构依赖的全链路分析。

核心查询能力

  • `repo query --kind`:代码级精准检索,支持 8 种查询类型:
  • hybrid:自然语言混合检索,适合模糊概念探索
  • symbol:符号名称精确匹配(类、函数、常量等)
  • definition:定义/声明位置定位
  • references:引用溯源与使用场景分析
  • callers/callees:双向调用链分析(单跳边界)
  • imports:模块导入依赖图谱
  • sbom:软件物料清单(依赖清单解析)
  • `repo software --kind`:仓库级软件图谱投影,涵盖依赖关系、SDK/API 使用、构建目标、IaC 资源、设计文档等 9 个维度,支持 relationships 跨域关联分析。
  • `repo feature-flags`:特性开关与配置门控的专项检索,识别灰度发布、环境变量门控等 guarded-code 模式。

索引与状态驱动工作流

大型冷仓库的初始索引采用异步状态机设计repo index 可能返回后台任务 ID 后超时,需通过 repo status <alias> 轮询 active_task、检查点计数器与租约过期时间,或使用 repo index-worker --task-id 执行有界单试工作器。该设计避免长时间阻塞 foreground 会话,适配 Agent 工具调用的超时约束。

架构与部署特性

  • 本地优先:默认使用捆绑的 Linux x64/Windows x64 原生二进制,避免 PATH 依赖;支持 RELAY_KNOWLEDGE_HOME 隔离环境
  • 多后端支持:语义检索可选 local/remote embedding,向量检索支持本地 faiss 模式
  • 跨平台 CLI:POSIX shell、PowerShell、cmd.exe 全适配,提供 per-command 环境注入范例
  • 诊断体系setup doctorhealthservice doctoraudit query 四级诊断链

显著优点

1. 图语义优于文本搜索:明确优先于 grep/ripgrep,除非 CLI 不可用或需原始正则
2. 生产级索引容错:租约机制、检查点持久化、Bounded worker retry 保障大仓库冷启动可靠性

3. GraphRAG 原生设计:查询结果携带 freshness 元数据,支持 wait-until-fresh 一致性等待

4. 零外部依赖运行:本地 embedding/vector backend 支持离线、隔离测试场景

潜在局限

  • 调用链边界限制callers/callees 仅暴露单跳边,多跳分析需客户端迭代组合
  • 冷索引启动成本:大型仓库首次索引耗时显著,需理解状态机模式而非同步等待
  • 平台兼容性约束:捆绑二进制依赖 glibc 2.31+;旧版 Linux 需切换至 PATH 安装版本
  • 非 MCP 协议:明确排除 Model Context Protocol 相关操作,需独立技能处理

适用人群

  • 代码架构师与 Tech Lead:依赖图谱分析、模块边界评估、技术债热点识别
  • Agent 开发者:构建代码问答、影响面分析、重构建议的 RAG pipeline
  • DevEx 团队:特性开关审计、配置门控治理、跨仓库知识标准化
  • 安全审计人员:SBOM 生成、依赖漏洞影响面分析(结合外部漏洞数据库)

常规风险

| 风险类别 | 说明 | 缓解措施 |
|---------|------|---------|
| 索引任务悬挂 | 进程杀死后租约未释放 | 检查 `lease_expires_at_ms` 后等待或手动释放 |
| 竞态工作器 | 多 Agent 同时启动 index-worker | 通过 `repo status` 确认无活跃任务后再执行 |
| 环境隔离失效 | `RELAY_KNOWLEDGE_HOME` 未透传 | 使用 per-command 内联赋值或工具环境映射 |
| 版本漂移 | PATH 二进制与捆绑资产版本不一致 | 优先 `version --format json` 校验,诊断时显式对比 |
| 网络代理遗漏 | 企业环境下载/校验失败 | 前置提示配置 `HTTPS_PROXY`/`HTTP_PROXY`/`NO_PROXY` |

整体而言,Relay Knowledge CLI 是面向现代代码库的深度语义查询基础设施,其价值在于将"代码即文本"提升为"代码即图谱",使 Agent 能够以结构化、可验证的方式理解软件系统的拓扑与演进。

Relay Knowledge CLI 内容

agents文件夹
references文件夹
手动下载zip · 17.3 kB
openai.yamltext/plain
请选择文件