
zvec-grep
本地工作区一句话搜代码和文档,人和 AI 都能用
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-09-22 · 当前星标 ★ 4239
使用教程
⚠ 本教程由 AI 依据该项目 README 整理;原始文档不完整,部分步骤为通用流程推断,实际安装请以项目官方文档为准。
⚠ 该项目 README 未提供完整安装说明,以下步骤为通用流程,请以官方文档为准。
环境要求
- 可用的 Node.js / npm 环境(项目通过 npm 包 @zvec/zvec-grep 分发)
- 一个本地工作区或文件目录,用于建立本地索引
- 本地磁盘空间,用于存放索引文件
- 无需联网:项目为本地优先设计,数据不需要上传云端
安装与启动步骤
-
1检查 Node 环境
项目以 npm 包形式发布,先确认本机已装 Node.js 与 npm,能正常输出版本号即可。
node -v npm -v -
2安装 zvec-grep
从 npm 安装官方包 @zvec/zvec-grep,全局安装后即可在任意目录调用命令行工具。
npm install -g @zvec/zvec-grep -
3进入工作区
切换到你要检索的本地代码或文档根目录,索引会围绕该目录构建,请改成自己的真实路径。
cd /your/workspace -
4准备示例数据
README 第 1 节标题为 Set up a sample bookshelf,节选未给出具体命令,请对照完整 README 执行。
-
5执行本地检索
在终端用 CLI 搜索,或让 AI Agent 通过 MCP 协议调用;具体子命令与参数请以官方 README 为准。
如何确认成功
终端能查到 @zvec/zvec-grep 的安装版本、并正常输出工具帮助信息,即表示安装成功。
常见问题
Q:使用它需要把代码上传到云端吗?
A:不需要。项目强调本地优先、数据留在本地,索引和检索都在本机完成,适合隐私和延迟敏感的场景。
Q:它支持哪些检索方式?
A:同时支持传统全文搜索(BM25、ripgrep 式代码搜索)和向量语义检索,既能按关键词精确命中,也能按语义找到相关片段。
Q:AI Agent 怎么接入?
A:项目提供 MCP 接口,Agent 可通过 MCP 协议调用,把本地工作区变成模型可检索的知识库;人类也可直接用 CLI。
Q:安装命令在 README 里没找到怎么办?
A:本教程依据 README 节选推断,安装与使用细节请以仓库中完整的 README / README_CN.md 为准。
注意事项
- README 节选中未包含完整安装命令与参数说明,实际命令请以仓库官方文档为准。
- 项目采用 Apache 2.0 许可,商用前建议确认许可条款。
- 命令行工具名称与子命令未在节选中给出,请勿凭猜测随意传参。
核心亮点
- Rust 实现,本地索引与检索,无需上传代码,隐私和延迟友好
- 同时支持 BM25/ripgrep 式关键词搜索与向量语义搜索,兼顾精确和模糊匹配
- 提供 CLI 和 MCP 接口,AI Agent 可直接接入,适合做本地知识检索层
不足之处
- 向量检索需要本地嵌入模型或额外配置,首次使用门槛高于纯 grep 工具
- 项目处于成长阶段,生态集成和长期维护情况待观察
适用场景
- 开发者在大型代码库中快速定位函数、配置或文档片段
- AI 编程助手通过 MCP 检索本地仓库上下文,减少幻觉
- 团队在离线或内网环境中搭建私有代码/文档搜索
替代项目
ripgrep、Sourcegraph、Meilisearch
上一篇:docsagent
下一篇:thesys-core
同类项目推荐
trove-ai
开源
一键收藏中文网页,AI 自动整理成个人知识库
中文互联网内容的个人 AI 稍后读 + 知识库 · Read-later + AI knowledge base for the Ch···
awesome-jev
开源
按决策模式查AI Agent资源,选型不迷路
Launch what you built on Jev, TypeSafe AI's System One decision model: a weekly boar···
FlashRAG
开源
一键复现主流RAG算法,快速搭建实验流水线
⚡FlashRAG: A Python Toolkit for Efficient RAG Research (WWW2025 Resource)
DeepRetrieval
开源
越搜越会搜,答案准到像请了专家
[COLM’25] DeepRetrieval — Training Search Agent by RLVR with Retrieval Outcome
awesome-rag-production
开源
照着清单选型,少踩RAG生产环境的坑
A curated list of battle-tested tools, frameworks, and best practices for building s···
session-knowledge
开源
把 Claude Code 聊天记录变成本地可搜索知识库
Turn your Claude Code session history into a searchable local knowledge base — 13 M···
WikiChat
开源
让聊天机器人不再胡说八道,回答自带来源引用
WikiChat is an improved RAG. It stops the hallucination of large language models by ···
azure-search-vector-samples
开源
照着 Notebook 跑一遍,就能在 Azure 上搭起向量搜索
A repository of code samples for Vector search capabilities in Azure AI Search.
VideoRAG
开源
把视频变成可检索的知识库,直接问答还能给依据
VideoRAG: Retrieval-Augmented Generation over Video Corpus