量子分子动力学
qmd 是一个用于索引和搜索markdown注释的命令行工具。\ 它支持全文搜索（BM25）、语义向量搜索和混合搜索（RRF）。\ 您可以使用以下任一方法生成嵌入 奥拉玛 服务器或 局部推断 （通过嵌入式 llama.cpp / yzma).
特性
- 全文检索：使用BM25和上下文提取进行快速关键字搜索。
- 向量搜索：使用嵌入的语义搜索（Ollama或Local）。
- 混合搜索：使用互惠排名融合（RRF）将关键字和语义搜索结合起来，以获得最高的准确性。
- 存档支持：直接从Zstandard压缩档案中索引大量文档集(
.zst/.zstd)无需解压，兼容 fcopy. - 智能拆分：使用上下文感知的Markdown拆分（通过LangChainGo）以获得更好的嵌入质量。
- MCP 服务器：通过以下方式展示搜索功能 模型上下文协议，允许AI助手（如Claude Desktop）搜索您的笔记。
- 聊天：交互式聊天界面，使用具有上下文感知响应的自然语言查询您的索引笔记。
- 独立：配置和索引存储在本地SQLite文件中(
./qmd.sqlite默认情况下），以便您可以针对不同目的指向不同的数据库。
起源
与原始版本存在一些固执己见的差异，使其有点不同，主要是所有配置和设置都包含在db文件中，这使得在不同的地方和多种场景中重用索引成为可能。
先决条件
- 转到1.25+
- C编译器 （gcc或clang）用于SQLite扩展。
嵌入
使用嵌入是可选的，默认情况下qmd将默认为SQLite FTS5 BM25。
嵌入选项A:Ollama
安装并运行 奥拉玛.
嵌入选项B：局部推断（建议用于性能/控制）
如果您更喜欢直接在内部运行模型 qmd 如果没有外部服务器，您需要 llama.cpp 共享图书馆。我们使用 伊斯玛 可以管理这些库，但您可以从手动下载和复制库 llama.cpp 项目。
- 安装
yzma工具：
go install github.com/hybridgroup/yzma/cmd/yzma@latest- 下载
llama.cpp库：
选择一个位置（例如。， ~/lib/yzma).
# CPU Only
yzma install --lib ~/lib/yzma
# CUDA (NVIDIA GPU)
yzma install --lib ~/lib/yzma --processor cuda
# Vulkan (AMD GPU)
yzma install --lib ~/lib/yzma --processor vulkan- 下载嵌入模型：
您将需要一个GGUF模型文件（例如。， nomic-embed-text-v1.5.Q4_K_M.gguf).
安装
# Clone the repository
git clone https://github.com/akhenakh/qmd.git
cd qmd
# Build with FTS5 support (Required)
go build -tags sqlite_fts5快速启动工作流
qmd 将所有内容存储在本地数据库中（默认值： ./qmd.sqlite).您不需要手动编辑配置文件；运行命令时，设置会存储在数据库中。
1.索引注释
添加一个或多个包含markdown文件或单个压缩档案的目录。
qmd add ./example ~/Documents/Obsidian ./docs/bento-v1.md.zst2.全文搜索
您可以立即使用关键字（BM25）进行搜索。
qmd search "postgres slow"3.生成嵌入
启用语义搜索(vsearch)混合搜索(query)，您必须配置嵌入模型并生成向量。此命令将配置保存到数据库以备将来更新。
使用局部推理（llama.cpp）：
qmd embed --local --model-path /opt/ml/nomic-embed-text-v1.5.Q8_0.gguf --lib-path ~/lib/yzma或者使用Olama：
qmd embed --url http://localhost:11434 --model nomic-embed-text4.搜索
语义搜索（仅矢量）：
qmd vsearch "performance issues with database"混合搜索（最佳质量）： 结合关键字匹配和语义理解。
qmd query "quarterly planning process"详细用法
全球旗帜
- `--db
：SQLite数据库的路径（默认 ./qmd.sqlite`).如果要维护不同的索引，请使用此选项。
命令
add [path...]
将文件夹或存档添加到索引配置中。
- 目录：递归扫描
.md文件夹。 - 档案：索引
.zst或.zstd文件夹。
- 格式要求：存档必须包含连接的markdown文件，由指定相对路径的代码块分隔。
# File Content
qmd add ~/Notes ./docs/large-docs.md.zst
#### `update`
重新扫描所有已配置的集合，以查找新的或已修改的文件。
- 立即更新FTS索引。
- 如果已配置嵌入（通过 `qmd embed` 以前），它会自动为新内容生成嵌入。
qmd update
#### `search [query]`
标准关键字搜索（BM25）。
- `--context N`：显示N行上下文（默认为0）。
- `--all`：显示文件中的所有匹配项（默认为false）。
qmd search "meeting" --context 2
#### `embed`
配置嵌入设置并为待处理文档生成向量。
- **旗帜**:
- `--local`：启用本地llama.cpp模式。
- `--model-path`：GGUF模型路径（本地）。
- `--lib-path`：通往llama.cpp库的路径（本地）。也可以使用 `YZMA_LIB` 有人是。
- `--url`：ollama URL（默认） `http://localhost:11434`).
- `--model`：型号名称（默认 `nomic-embed-text`).
- `--dim`：矢量尺寸（默认值 `768`).
#### `vsearch [query]`
对生成的嵌入执行余弦相似性搜索。需要 `embed` 至少跑过一次。
#### `query [query]`
执行混合搜索。它同时运行全文搜索和矢量搜索，然后使用交互秩融合（RRF）组合结果。通过平衡精确的关键字匹配和语义含义，这通常比单独使用任何一种方法都能提供更好的结果。
#### `info`
显示当前配置、索引集合和数据库统计信息。
qmd info
#### `server`
启动模型上下文协议（MCP）服务器以与AI代理集成。
#### `chat`
启动交互式聊天会话，使用自然语言查询您的索引笔记。聊天界面使用您的索引内容提供上下文感知响应。
qmd chat
## MCP服务器集成
连接 `qmd` 像Claude Desktop这样的人工智能代理。
### 克劳德
**`claude_desktop_config.json`:**
{ "mcpServers": { "qmd": { "command": "/absolute/path/to/qmd", "args": ["server", "--db", "/absolute/path/to/qmd.sqlite"] } } }
### 米斯特拉尔·维贝
[[mcp_servers]] name = "qmd" transport = "stdio" command = "/absolute/path/to/qmd" args = [ "server", "--db", "/absolute/path/to/qmd.sqlite", ] prompt = "Use qmd to search through indexed markdown notes and documentation. It supports semantic search. Use the 'query' tool for most questions as it combines keyword and vector search for best results. Use 'get_document' to read the full content of a file found via search."
### 外露工具
当作为MCP服务器运行时， `qmd` 向AI代理公开以下工具：
- **`search`**：全文搜索（BM25）。适用于特定关键字。
- **`vsearch`**：语义向量搜索。对概念有好处。
- **`query`**：混合搜索（BM25+矢量+RRF）。最稳健的搜索方法。
- **`get_document`**：检索特定文件的完整内容。
- **`status`**：返回索引统计信息。
## 许可证
麻省理工学院