QMD
QMD 是一个本地优先的迷你 CLI 搜索工具,用于检索文档、知识库、会议记录等文本。它结合 BM25 全文搜索、向量语义搜索和 LLM 重排序,并通过 node-llama-cpp 与 GGUF 模型全程在设备端运行。
访问 tobi/qmd项目简介
QMD 是一个设备端搜索工具,用于检索 markdown 笔记、会议记录、文档和知识库中的内容。它支持关键词和自然语言搜索,结合 BM25 全文搜索、向量语义搜索和 LLM 重排序,并通过 node-llama-cpp 与 GGUF 模型全程在本地运行。
核心功能
- 混合搜索结合 BM25 全文搜索、向量语义搜索和 LLM 重排序。
- 通过 node-llama-cpp 与 GGUF 模型在设备端本地运行。
- 可索引 markdown 笔记、会议记录、文档和知识库的集合。
- 通过 search、vsearch 和 query 命令支持关键词与自然语言查询。
- 提供 MCP 服务器,包含 query、get、multi_get 和 status 工具,用于智能体集成。
- 提供 Node.js 和 Bun SDK,可将搜索嵌入应用。
适用场景
- 从命令行搜索个人笔记、会议记录、文档和知识库。
- 通过 JSON 和文件输出将结构化搜索结果提供给 AI 智能体和 LLM 工作流。
- 使用 SDK 为 Node.js 或 Bun 应用添加本地文档检索。
- 让 Claude Desktop 或 Claude Code 等 MCP 客户端查询本地已索引内容。
快速开始
- 使用 npm install -g @tobilu/qmd 或 bun install -g @tobilu/qmd 全局安装,也可用 npx @tobilu/qmd 或 bunx @tobilu/qmd 直接运行。
- 使用 qmd collection add 为笔记、文档和会议记录创建集合,再用 qmd context add 添加上下文。
- 用 qmd embed 生成嵌入,并用 qmd search 进行关键词搜索、qmd vsearch 进行语义搜索,或用 qmd query 进行带重排序的混合搜索。
- 配置 MCP 客户端运行 qmd mcp,或用 qmd mcp --http 启动 HTTP 传输。
部署与要求
- Node.js 版本 22 或更高。
- Bun 版本 1.0.0 或更高。
- 在 macOS 上,需要 Homebrew SQLite 以支持扩展。
- 本地 GGUF 模型在首次使用时从 HuggingFace 自动下载并缓存;默认模型包括 embeddinggemma-300M-Q8_0、qwen3-reranker-0.6b-q8_0 和 qmd-query-expansion-1.7B-q4_k_m。
- 切换嵌入模型时需用 qmd embed -f 重新索引,因为向量在不同模型之间不兼容。
采用前须知
- 许可证:MIT。在使用、修改或分发项目前,请确认其具体条款。