qmd

🔍 本地隐私优先的智能文档检索

Shopify CEO 开源的本地文档搜索引擎,支持 BM25+向量混合检索,数据完全本地处理保障隐私。

收藏
4.4k
安装
914
版本
v1.0.0
CLS 安全性认证2026-05-20
点击查看完整报告 >

使用说明

核心用法

qmd 是一款本地优先的文档搜索与索引 CLI 工具,专为开发者知识管理设计。用户通过 qmd collection add 添加待索引目录(支持 glob 掩码如 **/*.md),执行 qmd update 构建索引后,即可使用三种检索模式::qmd search 进行传统 BM25 文本搜索,,qmd vsearch 启用语义向量搜索,,qmd query 则融合两者实现混合检索。文档获取支持行号定位与长度控制,如 qmd get docs/path.md:10 -l 40。工具同时提供 MCP(Model Context Protocol)模式,可无缝接入 AI 助手工作流。

显著优点

本地隐私优先:所有嵌入生成与重排序均通过本地 Ollama 完成,无需上传数据至云端,彻底解决敏感文档的隐私顾虑。检索精度高:BM25 与向量检索的混合架构兼顾关键词匹配与语义理解,rerank 机制进一步提升结果相关性。生态整合:MCP 模式使其成为 AI 编程助手的上下文增强器,让大模型直接访问个人知识库。轻量易用:单一二进制文件,索引自动缓存于 ~/.cache/qmd,配置通过环境变量即可完成。

潜在缺点与局限性

硬件依赖:向量搜索依赖本地 Ollama 服务,需额外部署 embedding 模型,对低配设备有一定资源压力。索引维护成本:文档变更后需手动执行 qmd update,无实时监听机制,大规模目录的增量更新效率待验证。格式支持有限:当前主要针对 Markdown 优化,PDF、Office 等富格式文档支持不足。跨设备同步:索引与缓存绑定单机,多设备场景下需自行解决知识库同步问题。

适合的目标群体

技术文档重度使用者、个人知识管理(PKM)实践者、需要为 AI 助手提供私有上下文的开发者、以及注重数据隐私的企业知识库管理员。特别适合已部署 Ollama 本地 AI 栈的技术用户。

使用风险

性能风险:首次索引大规模代码库可能耗时较长;向量检索在高并发场景下响应延迟需关注。依赖项风险:Ollama 服务异常将直接导致语义搜索失效,需保障本地模型服务的稳定性。数据安全:虽为本地处理,但索引文件以明文形式存储于缓存目录,共享设备需注意目录权限配置。

安全解读

核心用法

qmd 是一款由 Shopify 创始人 Tobi Lutke 开发的本地文档索引与搜索工具,通过 MCP 模式为 AI 提供强大的本地知识检索能力。

索引管理

  • 添加文档集合:qmd collection add /path --name docs --mask "**/*.md",支持通配符批量索引
  • 更新索引:qmd update 增量同步文件变更
  • 状态检查:qmd status 查看索引健康度

多模态检索

  • BM25 关键词搜索:qmd search "query",适合精确匹配
  • 向量语义搜索:qmd vsearch "query",基于 Ollama 本地嵌入模型理解语义
  • 混合检索:qmd query "query",融合 BM25 与向量优势自动排序
  • 文档片段获取:qmd get docs/path.md:10 -l 40,直接定位第10行起40行内容

MCP 集成模式
运行 qmd mcp 启动 MCP 服务器,使 Claude 等 AI 能够直接调用索引进行上下文感知问答。

显著优点

1. 本地化隐私优先:所有索引存储于 ~/.cache/qmd,嵌入计算通过本地 Ollama 完成,文档数据零上云
2. 混合检索算法:BM25 保证关键词召回,向量检索捕捉语义关联,rerank 优化最终排序

3. 轻量级设计:37 行纯 Markdown 文档型 Skill,无可执行代码,CLS 认证 S+ 满分

4. 开发者背景权威:维护者为 Shopify 创始人,GitHub 高影响力开源贡献者

潜在缺点与局限性

  • 依赖外部安装:需用户自行通过 npm 安装 qmd CLI,安装步骤不在 Skill 自动化范围内
  • Ollama 前置要求:向量搜索与 rerank 功能强制依赖本地 Ollama 服务,需额外配置环境变量 OLLAMA_URL
  • 无实时同步qmd update 为手动触发,非文件系统监听自动更新
  • T3 来源分级:虽作者知名,但项目属个人维护而非基金会背书,长期维护稳定性需观察

适合人群

  • 需要本地化知识库检索的隐私敏感用户
  • 已部署 Ollama 的 AI 开发者与技术写作者
  • 使用 MCP 协议扩展 AI 上下文能力的进阶用户
  • Markdown/代码文档量大的个人或小型团队

常规风险

  • CLI 依赖风险:Skill 本身 S+ 安全,但所调用的 qmd CLI 由 npm 分发,建议从官方 GitHub 源安装并校验签名
  • Ollama 服务暴露:默认 localhost:11434 若被修改指向外部端点,可能导致文档内容外泄,建议网络隔离
  • 索引存储位置:默认 ~/.cache/qmd 可能受系统清理策略影响,重要索引建议定期备份

qmd 内容

手动下载zip · 912 B
SKILL.mdtext/markdown
请选择文件