使用 qmd 从本地知识库搜索和检索 markdown 文档。支持 BM25 关键词搜索、向量语义搜索及结合 LLM 重排序的混合搜索。适用于查询索引笔记、文档、会议记录及任何基于 markdown 的知识。需安装 qmd CLI (bun install -g https://github.com/tobi/qmd)。
QMD - 本地马克下搜索是一项面向实际任务的技能,主要用于搜索并检索本地索引的马克下的知识库中的文档;Setup.;
该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
从本地索引的 Markdown 知识库中搜索并检索文档。
bun install -g https://github.com/tobi/qmd
# 添加一个集合 qmd collection add ~/notes --name notes --mask "**/*.md" # 生成嵌入向量(vsearch/query 所必需) qmd embed
调用 qmd 命令时,始终使用 --json 标志,以获得结构化输出。
qmd search "authentication flow" --json qmd search "error handling" --json -n 10 qmd search "config" --json -c notes
qmd vsearch "how does login work" --json qmd vsearch "authentication best practices" --json -n 20
qmd query "implementing user auth" --json qmd query "deployment process" --json --min-score 0.5
| 选项 | 说明 |
|---|---|
-n NUM |
返回结果数量(默认为 5;启用 --json 时默认为 20) |
-c, --collection NAME |
限定在指定集合内搜索 |
--min-score NUM |
最低匹配分数阈值 |
--full |
在结果中返回完整文档内容 |
--all |
返回所有匹配项 |
qmd get docs/guide.md --json qmd get "#a1b2c3" --json qmd get notes/meeting.md:50 -l 100 --json
qmd multi-get "docs/*.md" --json qmd multi-get "api.md, guide.md, #abc123" --json qmd multi-get "notes/**/*.md" --json --max-bytes 20480
qmd update # 重新索引已更改的文件 qmd status # 检查索引健康状态 qmd collection list # 列出所有集合
| 模式 | 速度 | 质量 | 适用场景 |
|---|---|---|---|
| search | 快 | 良好 | 精确关键词、已知术语 |
| vsearch | 中等 | 更优 | 概念性查询、同义词扩展 |
| query | 慢 | 最佳 | 复杂问题、术语不确定时 |
性能说明: vsearch 和 query 在首次运行时存在约 1 分钟的冷启动延迟(用于向量初始化)。交互式使用时建议优先选用 search。
QMD 可作为 MCP 服务器运行,支持直接集成:
qmd mcp
暴露的工具包括:qmd_search、qmd_vsearch、qmd_query、qmd_get、qmd_multi_get、qmd_status
相关专题
热门下载
相关下载
精品课程
共6课时 | 54.6万人学习
共89课时 | 133.4万人学习
共49课时 | 82.2万人学习