kvault (Rabrooks)

四

可搜索的知识语料库，BM25排名。Rust库、CLI和MCP服务器。

状态

CLI、搜索和MCP服务器正常工作。可选的Tantivy（BM25）排名搜索后端可通过以下方式获得 ranked 功能。

什么是kvault？

kvault是一个快速、本地优先的知识库，可以让您：

• 商店 知识，如Markdown、JSON或纯文本
• 搜索 具有ripgrep（快速）或Tantivy BM25排名（可选）
• 访问 通过CLI、Rust库或MCP服务器

没有外部AI服务。没有嵌入API。你可以控制你的知识在哪里。

安装

需要 ripgrep 搜索：

brew install ripgrep    # macOS
cargo install ripgrep   # any platform
apt install ripgrep     # Debian/Ubuntu

安装kvault：

cargo install kvault

或者从源代码构建：

git clone https://github.com/aaronbrooks/kvault
cd kvault
cargo build --release

# With MCP server support
cargo build --release --features mcp

# With ranked search (BM25 + fuzzy matching)
cargo build --release --features ranked

# Full build with all features
cargo build --release --features "ranked,mcp"

快速开始

添加文档：

echo "# Lambda Patterns

Use environment variables for configuration.
Keep functions small and focused.
" | kvault add --title "AWS Lambda Patterns" --category aws --tags "lambda,serverless"

或者从文件中：

kvault add --title "AWS Lambda Patterns" --category aws --file ./notes.md

然后搜索并检索：

kvault list                           # List all documents
kvault search "environment"           # Search content
kvault get aws/aws-lambda-patterns.md # View full document

CLI命令

kvault add --title "..." --category "..." [--tags "..."] [--file path]
                               # Add document (reads stdin if no --file)
kvault search           # Search the corpus (case-insensitive)
kvault search  -l 5     # Limit results
kvault search  -c aws   # Filter by category
kvault search  -s       # Case-sensitive search
kvault search  -b ranked # Use BM25 ranked search (requires --features ranked)
kvault search  --fuzzy  # Fuzzy search with edit distance 1 (ranked backend)
kvault search  --fuzzy 2 # Fuzzy search with edit distance 2
kvault list                    # List all documents
kvault list --category aws     # Filter by category
kvault get 
              # Print document contents
kvault index                   # Build search index (requires --features ranked)
kvault serve                   # Start MCP server (requires --features mcp)

配置

配置文件： ~/.config/kvault/config.toml

[corpus]
paths = [
  "~/.kvault",              # default location
  "./.kvault",              # add project-specific paths as needed
  "~/work/shared-kb",       # or team/custom locations
]

违约： ~/.kvault 如果不存在配置文件，则使用。

环境变量

存储后端

搜索后端

排名搜索（坦特维）

使用排名搜索支持进行构建：

cargo build --release --features ranked

构建搜索索引（使用排名搜索前需要）：

kvault index

使用排名搜索：

# Explicit ranked backend
kvault search "lambda patterns" --backend ranked

# Auto-select (uses ranked if index exists, else ripgrep)
kvault search "lambda patterns" --backend auto

# Fuzzy search - finds "lambda" even if you type "lamda"
kvault search "lamda" --fuzzy        # 1 edit distance (default)
kvault search "lamda" --fuzzy 2      # 2 edit distance (more permissive)

编辑距离指南：

MCP服务器

kvault包括一个用于AI编辑器集成的MCP服务器。在MCP支持下构建：

cargo build --release --features mcp

添加到编辑器的MCP配置中：

{
  "mcpServers": {
    "kvault": {
      "command": "kvault",
      "args": ["serve"]
    }
  }
}

支持的编辑器

• 克劳德代码
• 光标
• 帆板运动
• 任何支持模型上下文协议的编辑器

MCP工具

功能标志

许可证

麻省理工学院