AutoRAG

让 AI 帮你秒搜电脑里的任何东西，越用越聪明

开源 🏷️完全免费 🔧 仅开源项目，无在线服务，需自行部署搜索知识 🍴 复刻 488 🐛 待处理 82 👀 关注 35

访问官网 ↗ GitHub ↗

GitHub 星标 ★ 5412

维护状态活跃

是否开源开源

定价模式 🏷️完全免费开源项目，本地部署，完全免费。

项目预览

项目数据

分类搜索知识

开发团队Marker-Inc-Korea

官网地址https://marker-inc-korea.github.io/AutoRAG

GitHubhttps://github.com/Marker-Inc-Korea/AutoRAG

定价模式🏷️完全免费

价格说明开源项目，本地部署，完全免费。

访问状态🔧 仅开源项目，无在线服务，需自行部署

是否开源是

开源协议Apache-2.0

主要语言TypeScript

技术栈/模型agent,document-parser,embeddings,librarian,llm,open-source,pipeline,qa,rag,retrieval-augmented-generation

GitHub 星标★ 5412

上线时间2024-01-10 00:00:00

代码更新2026-11-09

仓库体积100.3 MB

本站数据更新2026-11-09

维护状态活跃

收录时间2026-08-09

浏览次数2

项目介绍

AutoRAG 是一个基于 TypeScript 构建的本地智能搜索工具，旨在让 AI 代理能够快速查找你电脑中的任何内容。它通过索引文件、应用数据、浏览器历史等本地信息，提供语义化搜索能力，解决传统文件搜索低效、无法理解自然语言的问题。核心能力包括：自动索引本地文件与元数据、支持自然语言查询、与 AI 代理无缝集成，并且会随着用户使用频率增加而优化搜索结果，越用越智能。项目当前处于成长阶段，适合个人开发者、知识工作者以及需要快速定位本地资源的场景。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化，观测越久曲线越完整

数据来源：GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 5412

技术标签

agent embeddings llm open-source pipeline

使用教程

ℹ 本教程由 AI 依据该项目 README 整理，个别步骤可能需要按你的环境微调。

难度：进阶约 15 分钟部署方式：命令行工具 8 步

环境要求

Node.js ≥ 24 或 Bun 运行时（dist 由 Bun 打包）
Java 11 或更高版本，且 JAVA_HOME/PATH 指向它（PDF 解析必需，Java 8 不支持）
已认证的模型 provider 或本地运行时（AutoRAG 不自带私有 provider 默认值）
可选：Rust 工具链（cargo），用于自动编译 MinSync / Jikji（缺失时核心 BM25 搜索仍可用）
可选：Bun（仅 Git 方式安装时需要，prepare 脚本会构建 dist/）

安装与启动步骤

1安装 autorag CLI

通过 Bun 全局安装 @autorag/librarian，安装后即可使用 autorag 命令。
```
bun install -g @autorag/librarian
```
2也可作为库安装

若要在 TypeScript 代码里以库方式调用 AutoRAGAgent，在项目内安装即可（与上一步二选一）。
```
bun add @autorag/librarian
```
3或从仓库直接安装

README 给出的仓库直装方式；Git 安装会用 prepare 脚本构建 dist，本机需有 Bun。
```
bun add github:NomaDamas/AutoRAG-2.0
```
4初始化配置

生成 ~/.autorag/config.json 等默认状态文件；不带模型参数时 model 字段会留空。
```
autorag init
```
5配置搜索路径

编辑 ~/.autorag/config.json，把 searchPaths 指向要检索的文档目录，并可选设置 workspacePath、memoryPath 和模型。
6校验 Java 环境

PDF 解析依赖 Java 11+，先确认 PATH 中实际选中的 Java 版本；Windows 上要让 Java 11+ 排在旧版本前面。
```
java -version
```
7刷新索引

对语料建立解析镜像与 BM25/MinSync 索引；可用 --method bm25,minsync,parsed 限定范围，省略则全部执行。
```
autorag refresh
```
8健康检查与打开界面

health 校验模型/provider 认证，status 查看索引新鲜度；ui 会打开仅回环可访问的本地配置页面。
```
autorag health
autorag status
autorag ui --no-open
```

关键配置

配置项	必填	说明	示例
`searchPaths`	是	要索引和检索的本地文档目录列表	`["/path/to/documents"]`
`workspacePath`	否	工作区路径，索引与二进制工具放在其 .autorag 下	`/path/to/workspace`
`memoryPath`	否	检索记忆文件路径，记录历史与反馈	`/Users/you/.autorag/memory.json`
`model`	否	指定 provider 与模型 id，需在已认证运行时中可用	`{"provider":"provider-name","id":"reasoning-model"}`
`ui.allowRemote`	否	允许非回环绑定，部署远端 UI 时必须显式开启	`true`
`ui.tokenEnv`	否	存放 UI 会话令牌的环境变量名（值至少 16 字符）	`AUTORAG_UI_TOKEN`

如何确认成功

执行 autorag status 确认语料新鲜度与 BM25/MinSync 就绪，autorag health 确认模型认证通过；autorag ui 能打开 127.0.0.1 页面即为正常。

常见问题

Q：索引 PDF 时报 Java 相关错误？

A：PDF 解析要求 Java 11 或更高（Windows/macOS/Linux 均如此），Java 8 不受支持。先运行 java -version 确认 PATH 中选中的版本，Windows 可设 JAVA_HOME 指向 Java 11+ 后重开终端。

Q：原来的 Python 版 AutoRAG 还能用吗？

A：能。原版 RAG AutoML 工具位于本仓库 legacy/ 目录，仍以维护模式更新，可用 pip install AutoRAG 安装，使用方式与之前完全一致。

Q：init 后没有配置 model 可以搜索吗？

A：可以尝试。搜索时 AutoRAG 会优先解析已认证的本地 provider；若解析不到，需要在 config.json 中显式配置 model 的 provider 与 id。

Q：MinSync、Jikji 没安装会怎样？

A：首次使用时自动安装到 <workspace>/.autorag/bin（MinSync 先走 cargo install minsync，Jikji 用 cargo 编译）。缺失时所有能力都会优雅降级，核心 BM25 搜索仍可正常工作。

Q：配置文件到底读哪一个？

A：优先级为 --config 参数 > 环境变量 AUTORAG_CONFIG > ~/.autorag/config.json。当 home 配置不存在且当前目录有 autorag.config.json 时，会复制为 home 配置（不删除原文件）。

注意事项

UI 默认只绑定回环地址；若确需远端部署，必须在 config.json 中显式开启 allowRemote 并设置公共 origin 与 CORS，同时把至少 16 字符的随机令牌放进 AUTORAG_UI_TOKEN 环境变量。
索引属于工作区本地数据：解析镜像与 BM25/MinSync 索引保存在 <workspace>/.autorag 下，autorag index reset|rebuild 也会作用于这些目录。
模型认证始终由用户自己的 provider 或本地运行时负责，AutoRAG 不附带私有 provider 默认值。
交互式搜索建议选择工具调用可靠、输出 TPS 高、首 token 延迟低的模型；大推理模型用于难合成任务，但不是普通检索的必需条件。

核心亮点

支持自然语言搜索，无需记住文件名或路径
自动索引本地文件与应用数据，搜索覆盖面广
与 AI 代理集成，可编程调用，扩展性强

不足之处

项目尚在成长中，稳定性和兼容性待验证
文档/社区待观察

适用场景

个人知识管理，快速查找笔记、文档
开发者快速定位项目文件与代码片段
AI 助手增强本地资源检索能力

替代项目

Haystack、LlamaIndex、txtai

上一篇：SQLBot

下一篇：53AIHub