QMD - 本地 Markdown 搜索

从本地索引的 Markdown 知识库中搜索和检索文档。

安装

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

设置

# Add a collection
qmd collection add ~/notes --name notes --mask "**/*.md"

# Generate embeddings (required for vsearch/query)
qmd embed

使用规则

始终使用--json标志在调用 qmd 命令时以获取结构化输出。

搜索命令

search (BM25 关键词搜索 - 快速)

qmd search "authentication flow" --json
qmd search "error handling" --json -n 10
qmd search "config" --json -c notes

vsearch (向量语义搜索)

qmd vsearch "how does login work" --json
qmd vsearch "authentication best practices" --json -n 20

query (混合搜索，带 LLM 重新排序 - 质量最佳)

qmd query "implementing user auth" --json
qmd query "deployment process" --json --min-score 0.5

搜索选项

检索命令

获取（单个文档）

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              # Re-index changed files
qmd status              # Check index health
qmd collection list     # List all collections

搜索模式选择

性能说明： vsearch和query在向量初始化时有约1分钟的冷启动延迟。对于交互式使用，建议优先使用search。

MCP 服务器

qmd 可以作为 MCP 服务器运行以实现直接集成：

qmd mcp

暴露的工具：qmd_search、qmd_vsearch、qmd_query、qmd_get、qmd_multi_get、qmd_status