本地Markdown检索

5小时前更新 1 00
本地Markdown检索本地Markdown检索
本地Markdown检索

技能简介

qmd-cli 是一款面向本地 Markdown知识库的命令行检索工具,支持关键词搜索、向量语义搜索及混合搜索三种模式,可对笔记、文档、会议记录等 Markdown 内容进行快速查询与获取。

能做什么

  • 基于 BM25 算法进行高速关键词匹配
  • 通过向量嵌入实现语义相似度搜索
  • 结合 LLM 重排序的混合搜索,提升结果质量
  • 单篇或多篇文档的精准获取
  • 索引维护与集合管理

使用说明

安装指令

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

初始化配置

# 添加文档集合
qmd collection add ~/notes --name notes --mask "**/*.md"
# 生成向量嵌入(vsearch/query 必需)
qmd embed

常用命令

所有调用必须附加 --json 标志以获取结构化输出:

# 关键词搜索
qmd search "authentication flow" --json

# 向量语义搜索
qmd vsearch "how does login work" --json

# 混合搜索(质量最优)
qmd query "implementing user auth" --json

# 获取单篇文档
qmd get docs/guide.md --json

# 批量获取文档
qmd multi-get "docs/*.md" --json

性能提示:vsearch 与 query 首次启动有约 1 分钟向量初始化延迟,交互场景建议优先使用 search。

输入与输出

见下方输入与输出表格。

项目内容
输入搜索关键词、文档路径或通配符;可选参数包括结果数量(-n)、目标集合(-c)、最低分数(–min-score)、完整内容(–full)
输出JSON 结构的结果集,含文档路径、标题、片段/全文、相关性评分、唯一标识符
适用人群本地知识库使用者、技术笔记管理者、需要将文档检索嵌入自动化流程的开发者
不包含网络资源检索、PDF/Word 等非 Markdown 格式支持、多用户协同编辑、可视化界面

 

风险提示

  • 向量搜索需预先执行 embed 生成索引,否则无法使用
  • 未加 –json 时输出为非结构化文本,不利于程序解析
  • 大规模知识库初次索引耗时较长
  • MCP 服务器模式需单独启动 qmd mcp

来源信息

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

数据统计

相关导航

暂无评论

none
暂无评论...