zvec-grep

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• 可用的 Node.js / npm 环境（项目通过 npm 包 @zvec/zvec-grep 分发）
• 一个本地工作区或文件目录，用于建立本地索引
• 本地磁盘空间，用于存放索引文件
• 无需联网：项目为本地优先设计，数据不需要上传云端

安装与启动步骤

1. 1检查 Node 环境

   项目以 npm 包形式发布，先确认本机已装 Node.js 与 npm，能正常输出版本号即可。

   node -v
   npm -v

   复制

2. 2安装 zvec-grep

   从 npm 安装官方包 @zvec/zvec-grep，全局安装后即可在任意目录调用命令行工具。

   npm install -g @zvec/zvec-grep

   复制

3. 3进入工作区

   切换到你要检索的本地代码或文档根目录，索引会围绕该目录构建，请改成自己的真实路径。

   cd /your/workspace

   复制

4. 4准备示例数据

   README 第 1 节标题为 Set up a sample bookshelf，节选未给出具体命令，请对照完整 README 执行。

5. 5执行本地检索

   在终端用 CLI 搜索，或让 AI Agent 通过 MCP 协议调用；具体子命令与参数请以官方 README 为准。

如何确认成功

终端能查到 @zvec/zvec-grep 的安装版本、并正常输出工具帮助信息，即表示安装成功。

常见问题

注意事项

• README 节选中未包含完整安装命令与参数说明，实际命令请以仓库官方文档为准。
• 项目采用 Apache 2.0 许可，商用前建议确认许可条款。
• 命令行工具名称与子命令未在节选中给出，请勿凭猜测随意传参。