TL

timorunge/lore

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

20 stars 0 forks 质量 76 趋势 30MIT

本地知识库支持90+文档格式。CLI搜索+MCP服务器。没有云端,没有API密钥。

概览

一个你可以从终端搜索或通过MCP提供给代理的本地知识库。Lore会接收你的文档——本地文件、网站、git仓库、订阅源、S3、YouTube、邮件、shell命令、上游MCP服务器、90+格式——并用全文搜索索引所有内容。没有外部服务,也无需管理基础设施。一个二进制文件,一个配置,一个存储——或者你需要的数量。 把你的项目看作是人手页面——无论是人类还是代理人。 或者直接从发布页面下载预构建的二进制文件。 Linux 和 macOS 都有预构建的二进制文件。在 Windows 上,建议使用 WSL(推荐)或通过 cargo install 从源代码构建(OCR 需要 cmake,且 MSVC 不支持 OCR——省略 --no-default-features --features ingest,mcp)。 Lore init 扫描你的目录,检测文档文件夹和 README 文件,生成带有预填源码的配置。查看、导入和搜索——无论是从你的终端还是通过任何 MCP 客户端。

概述(AI 翻译)

一个你可以从终端搜索或服务的本地知识库 特工们通过MCP获取。背景资料会接收你的文档——本地文件、网站, git仓库、订阅源、S3、YouTube、邮件、shell命令、上游MCP 服务器、90+格式——并通过全文搜索索引所有内容。 没有外部服务,也没有基础设施需要管理。一个二进制,一个 配置,一个商店——或者你需要的多个。

把你的项目想象成man页面——无论是人类还是代理人。

安装

安装脚本(Linux和macOS):

自制软件(macOS 和 Linux):

或者直接从 发布页面。

Windows: Linux和macOS已有预构建的二进制文件。 在Windows上,使用WSL (推荐)或用cargo install(需要OCR)从源头构建 cmake,且不支持MSVC——省略带有“–no-default-features”的 –features ingest,mcp’)。

从源头构建:

可选功能标志:

旗帜 默认 描述
ocr 在 扫描PDF和图像的OCR(需要cmake)
llm 关闭 大型语言模型丰富(lore ingest,lore enrich):Ollama、Anthropic、OpenAI 和 Bedrock
s3 关闭 亚马逊S3源码支持

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

lore

A local knowledge base you can search from the terminal or serve to agents over MCP. lore ingests your documents – local files, websites, git repos, feeds, S3, YouTube, email, shell commands, upstream MCP servers, 90+ formats – and indexes everything with full-text search. No external services, no infrastructure to manage. One binary, one config, one store – or as many as you need.

Think man pages for your projects – for humans and agents alike.

Install

Install script (Linux and macOS):

curl -fsSL https://github.com/timorunge/lore/releases/latest/download/lore-cli-installer.sh | bash

Homebrew (macOS and Linux):

brew install timorunge/tap/lore-cli

Or download a pre-built binary directly from the releases page.

Windows: Pre-built binaries are available for Linux and macOS. On Windows, use WSL (recommended) or build from source with cargo install (OCR requires cmake and is not supported on MSVC – omit with --no-default-features --features ingest,mcp).

Build from source:

git clone https://github.com/timorunge/lore.git
cd lore
cargo install --locked --path cli

Optional feature flags:

Flag Default Description
ocr on OCR for scanned PDFs and images (requires cmake)
llm off LLM enrichment (lore ingest, lore enrich): Ollama, Anthropic, OpenAI, and Bedrock
s3 off Amazon S3 source support
mcp on Upstream MCP server ingestion (resources and tool calls)
iwork off Apple iWork documents (Keynote, Pages, Numbers)
tree-sitter off Source code parsing via tree-sitter
cargo install --locked --path cli --features llm         # with LLM enrichment
cargo install --locked --path cli --features llm,s3      # with LLM + S3 support
cargo install --locked --path cli --all-features         # all optional features
cargo install --locked --path cli --no-default-features  # minimal build (no OCR, no MCP)

# Windows (native, no OCR):
cargo install --locked --path cli --no-default-features --features ingest,mcp

Quick start

cd my-project
lore init                     # generates .lore/lore.yaml from your project
lore ingest                   # build the store
lore search "authentication"  # search from the terminal
lore serve                    # or serve to agents over MCP

lore init scans your directory, detects documentation folders and README files, and generates a config with pre-filled sources. Review it, ingest, and search – from your terminal or through any MCP client.

Try it without your own docs

If you cloned the repo, the gutenberg example works out of the box:

cd examples/gutenberg
lore ingest
lore search "love and death"
在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "my-docs": { "command": "lore", "args": ["serve"], "env": { "LORE_CONFIG": "/path/to/.lore/lore.yaml" } } } }