
LEANN
让个人设备也能跑起又快又准的私有 RAG,存储省 97%。
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 13781
技术标签
使用教程
环境要求
- Python 环境,并使用 uv 作为包管理器(README 要求先安装 uv)
- git(用于克隆仓库获取示例)
- 本地生成模型需要安装 Ollama
- Windows 用户需要额外 C++ 工具链(cmake、swig、pkgconfiglite、nuget.commandline 及 vcpkg 依赖)
安装与启动步骤
-
1安装 uv
LEANN 官方推荐用 uv 管理环境与依赖,若本机没有 uv 先执行官方安装脚本,装完重新打开终端。
curl -LsSf https://astral.sh/uv/install.sh | sh -
2克隆仓库
克隆仓库以获取全部示例应用(apps 目录、demo.ipynb 等),随后进入项目目录。
git clone https://github.com/yichuan-w/LEANN.git leann cd leann -
3创建虚拟环境
在项目目录内用 uv 创建独立虚拟环境,并激活,避免污染系统 Python。
uv venv source .venv/bin/activate -
4安装 LEANN
从 PyPI 安装 leann 包,这是核心库,装完即可在代码中导入 LeannBuilder 等类。
uv pip install leann -
5安装生成模型 Ollama
LEANN 本地推理需要生成模型,README 提供 Ollama 安装脚本;不装则只能做检索、无法生成回答。
curl -fsSL https://ollama.ai/install.sh | sh -
6全局安装 CLI(可选)
若想让 leann 命令在任何目录可用,用 uv tool 全局安装 leann-core 并附带 leann。
uv tool install leann-core --with leann -
7接入 MCP(可选)
安装后把 leann-server 注册为 Claude 的 MCP 服务,即可在 Claude Code 中直接调用 LEANN 检索。
claude mcp add --scope user leann-server -- leann_mcp -
8Windows 依赖(可选)
Windows 上编译 C++ 依赖需先装工具链,再用 vcpkg 安装 zeromq、openblas、lapack、protobuf 等库。
choco install cmake swig pkgconfiglite nuget.commandline -y
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
INDEX_PATH | 否 | 索引文件的保存/加载路径,示例默认写到当前目录 | ./demo.leann |
--export-path | 否 | 对话导出路径,按扩展名决定 HTML 或 JSON 格式 | conversations.html |
--query | 否 | 单次查询内容;不传则进入交互式连续问答模式 | 你的问题 |
如何确认成功
激活虚拟环境后执行 `leann --help`,能正常打印命令行帮助信息即表示安装成功。
常见问题
Q:本机没有 uv 怎么办?
A:README 明确要求先安装 uv,执行 curl -LsSf https://astral.sh/uv/install.sh | sh 即可,安装后重开终端使命令生效。
Q:Windows 上安装失败怎么办?
A:需要额外 C++ 工具链:用 choco 安装 cmake、swig、pkgconfiglite、nuget.commandline,再用 vcpkg 安装 zeromq、openblas、lapack、boost-program-options、protobuf。
Q:如何让 leann 命令在任意目录可用?
A:用 uv tool install leann-core --with leann 全局安装;若在虚拟环境内,先 source .venv/bin/activate 再运行 leann --help。
Q:没有云端 API 能生成回答吗?
A:可以。LEANN 完全本地运行,安装 Ollama(curl -fsSL https://ollama.ai/install.sh | sh)后由本地模型完成生成,数据不出设备。
Q:处理 PDF 时提示缺少组件?
A:安装 colpali_engine、pdf2image、pillow 等依赖;macOS 还需 brew install poppler,否则 pdf2image 无法解析 PDF。
注意事项
- LEANN 主打本地化与隐私,官方声明零遥测,数据不会上传云端。
- 交互模式下不加 --query 即可连续提问,输入 quit 退出会话。
- Windows 用户务必先装好 choco/vcpkg 的 C++ 依赖,否则编译阶段容易失败。
- 安装步骤中的链接与包名均来自 README,建议先克隆仓库再按示例路径运行 apps 下的应用。
核心亮点
- 存储节省 97%,大幅降低本地 RAG 的部署门槛
- 完全本地化,数据隐私性强,不依赖云端
- 针对个人设备优化,查询速度快,准确度高
不足之处
- 文档/社区待观察
- 索引压缩可能带来一定的精度损失(需权衡)
适用场景
- 个人知识库管理(如笔记、文档)
- 离线智能问答助手(如车载、移动端)
- 隐私敏感场景(如医疗、法律文档检索)
替代项目
LlamaIndex、LangChain、txtai
同类项目推荐
Adaptive-rag
开源
按问题难度自动分流的电商客服 RAG,复杂问题多跳检索并自我纠错
按问题复杂度自动分流的电商客服 RAG:简单问题直接回答;复杂问题经过多跳检索并自我纠错···
ai_wiki
开源
一站收齐 AI 全栈学习资源与实战笔记
《AI全栈-全网优秀资源搜集站》:搜集全网优秀资源,记载工程实践问题的解决策略与关键要点···
vectordb-recipes
开源
照着做,快速搭建多模态 RAG 和 Agent 应用
Resource, examples & tutorials for multimodal AI, RAG and agents using vector search···
rag
开源
用 txtai 快速搭建 RAG,让 LLM 回答你的私有数据问题。
Retrieval Augmented Generation (RAG) with txtai. Combine search and LLMs to find ins···
LinearRAG
开源
把海量文档变成线性图,检索快十倍,内存省一半。
[ICLR 2026] LinearRAG: Linear Graph Retrieval Augmented Generation on Large-scale Co···
KAG
开源
专业资料问 AI 也能答得准,知识库不再吃灰
KAG is a logical form-guided reasoning and retrieval framework based on OpenSPG engi···
InstructRAG
开源
让 RAG 自己学会怎么检索,回答更准更靠谱
[ICLR 2025] InstructRAG: Instructing Retrieval-Augmented Generation via Self-Synthes···
KG_RAG
开源
用知识图谱给大模型装上结构化记忆,回答更准更可解释
Empower Large Language Models (LLM) using Knowledge Graph based Retrieval-Augmented ···
awesome-rag-production
开源
照着清单选型,少踩RAG生产环境的坑
A curated list of battle-tested tools, frameworks, and best practices for building s···