本地Markdown搜索

2小时前更新 2 00
本地Markdown搜索本地Markdown搜索
本地Markdown搜索

技能简介

qmd 是一款面向 Markdown 笔记与文档的本地搜索引擎,支持关键词检索(BM25)与语义向量检索两种模式,适合个人知识库的快速查找与内容定位。

能做什么

  • 对本地 Markdown 文件建立可搜索的索引
  • 通过关键词快速匹配相关内容
  • 利用语义相似度找到概念相关的笔记
  • 按集合管理多个文档来源
  • 输出 JSON 或文件列表,便于自动化处理

使用说明

安装指令

bun install -g https://github.com/tobi/qmd

前置要求

  • Bun >= 1.0.0(macOS 可用 brew install oven-sh/bun/bun
  • macOS 需额外安装 SQLite:brew install sqlite
  • 确保 PATH 包含 $HOME/.bun/bin

初始化配置

qmd collection add /path/to/notes --name notes --mask "**/*.md"
qmd context add qmd://notes "描述该集合"
qmd embed  # 启用向量检索(一次性)

常用命令

qmd search "查询词"              # 默认关键词检索,速度最快
qmd vsearch "查询词"             # 语义检索,冷启动较慢
qmd query "查询词"               # 混合检索+重排序,最慢
qmd get "path/to/file.md"        # 获取完整文档
qmd update                       # 增量更新索引
qmd status                       # 查看索引状态

性能建议

日常优先使用 qmd searchvsearch 仅在关键词检索无果时使用;query 因涉及 LLM 重排序,耗时长且易超时,非必要不选用。如需频繁语义检索,建议保持进程常驻以避免重复加载模型。

输入与输出

见下方输入与输出表格。

项目内容
输入自然语言查询词;可选指定集合名、结果数量、输出格式(JSON/文件列表)
输出匹配文档路径、内容片段或全文、相关性评分、文档ID
适用人群本地 Markdown 笔记用户、个人知识库管理者、重视数据隐私的离线检索需求者
不包含非 Markdown 文件检索、远程云文档搜索、代码仓库专用检索、实时协作功能

 

风险提示

  • 语义检索首次运行需下载 GGUF 模型,可能耗时数分钟
  • 向量检索冷启动时可能加载本地 LLM(如 Qwen3-1.7B),单次调用可达约1分钟
  • 混合检索模式(query)存在超时风险,不适合交互式场景
  • 索引需定期维护,否则新增或修改的文档无法被检索到

来源信息

原始链接:https://github.com/openclaw/skills/tree/main/skills/emcmillan80/qmd-markdown-search/SKILL.md
来源类型:GitHub 仓库

数据统计

相关导航

暂无评论

none
暂无评论...