DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.
🤝 欢迎各种形式的贡献! 在
Roadmap为议题投票或提出新建议,详见 贡献指南,了解分支策略、编码规范及参与方式。
📰 新闻动态
- 2026-09-20 🎉 9 个月突破 4 万 Star!我们将持续拓展 DeepTutor 的学习生态。
- 2026-05-22 🌐 官方文档站点上线 deeptutor.info — 指南、参考文档与能力演示一站汇聚。
- 2026-04-19 🎉 111 天突破 2 万 Star!感谢大家对真正个性化智能辅导的支持。
- 2026-04-10 📄 论文已发布于 arXiv — 阅读 预印本,了解 DeepTutor 的设计理念与背后的思考。
- 2026-02-06 🚀 仅 39 天突破 1 万 Star!衷心感谢我们出色的社区。
- 2026-01-01 🎊 新年快乐!加入我们的 Discord、微信群 或 Discussions — 一起塑造 DeepTutor 的未来。
- 2025-12-29 🎓 DeepTutor 正式发布!
✨ 核心功能
DeepTutor 是一个智能体原生的学习工作区,将辅导、解题、测验生成、研究、可视化和掌握度练习整合在一个可扩展的系统中。
- 统一的运行时 — Chat、Ask Questions、Quiz、Research、Visualize、Solve、Mastery Path、Immersive Reading 和 Audio Overview 共享同一套能力运行时与会话上下文,同时保留各自为特定用途设计的循环和流水线。
- Task Board — 在待办、进行中和已完成三个状态中追踪学习任务,支持添加备注、拖放或使用键盘可操作的移动按钮,并可从归档中恢复任务。卡片保留在当前工作区,沿用现有的外观和语言设置,无需配置模型。
- 互联的学习上下文 — 知识库、书籍、学习笔记本页面、收藏夹、题库、人格预设和 Memory 可在支持它们的工作流中复用,并受账号授权与学习策略约束。
- 沉浸式视频学习 — 将 YouTube 或 Bilibili 链接添加到 Reading,即可使用原生播放、转录搜索、基于时间戳的辅导、已保存的笔记和可续接的进度;YouTube 字幕和浏览功能可以使用由管理员配置的 Invidious 实例。
- 子智能体与 Partners — 在 Chat 中调用实时智能体运行框架(Claude Code、Codex、Grok CLI、Antigravity、Kimi、opencode、MiMo、Hermes、OpenClaw 或 DeepSeek)或 Partner、导入历史对话,并让持久化 IM 伴侣运行在同一套大脑之上。
- 多引擎知识库 — 跨 LlamaIndex、PageIndex、GraphRAG、LightRAG、远程 LightRAG Server、自托管的 WeKnora 知识库、Tencent IMA 或 MarginNote 4 知识库、已连接的 Kiwix ZIM 归档,或链接的 Obsidian vault 的版本化 RAG 知识库,支持可插拔的文档解析。详见原生 LightRAG 角色模型,了解独立的抽取、查询与视觉设置、仅默认创建以及确认后的重建。
- 可扩展工具与技能 — 内置工具、MCP 服务器、CLI 应用、图像 / 视频 / 语音生成模型,以及从 EduHub 安装的社区技能。
- 可审计的记忆 — L1 追踪、L2 表面摘要和 L3 综合让个性化透明可编辑;Memory Graph 将 L2 事实关联至 L1 证据,并将 L3 综合关联至参与的表面层。
🚀 快速开始
让你的智能体配置 DeepTutor
将以下提示复制给可使用终端的 AI 智能体(例如 Codex 或 Claude Code):
Help me install and configure the current dev version of DeepTutor from https://github.com/HKUDS/DeepTutor.
Clone the dev branch, or inspect and reuse my existing checkout, and read SKILL.md and
docs-for-dev/AGENT_SETUP.md first. Follow that guide to prepare the environment,
configure my model provider, verify the setup, and start the Web app.
Ask me for any missing provider, model, or credential-source information;
do not print API keys. Preserve my existing files and settings, and finish
with the access URL and the results of your checks.
智能体配置指南 涵盖完整流程,包括非交互式 CLI 配置。若要自行安装,请选择下方的一种方式。
DeepTutor 提供四种安装方式,四者共享同一套运行时主目录布局:私有设置存储在启动目录下的 data/user/settings/ 中(如果显式指定了 DEEPTUTOR_HOME / deeptutor start --home,则存储在该位置)。完整的存储布局、数据库支持和备份说明见本地数据持久化。完整应用的推荐流程为:选定运行时主目录 → 安装 → deeptutor init → deeptutor start。
一条命令 Docker 试用
如果尚未安装 Docker,请先安装 Docker;随后无需配置 Python 或 Node.js,即可直接试用完整应用:
docker run --rm --name deeptutor \
-p 127.0.0.1:3782:3782 \
-v deeptutor-data:/app/data \
ghcr.io/hkuds/deeptutor:latest
打开 http://127.0.0.1:3782,在 Settings → Providers 中配置模型提供商;体验结束后在该终端按 Ctrl+C 停止。名为 deeptutor-data 的卷会保留设置和本地数据,供下次启动复用。
内容工作区
内容工作区(Content Workspace) 与 DeepTutor 的私有运行时主目录相互独立。它是智能体可以读取的文件夹,生成的文件位于 outputs/<capability>/<session>/<turn>/ 下。自定义工作区将对话、学习素材、进度和缓存隔离在私有的 .deeptutor/data/ 目录树中,文件工具无法浏览该目录树。设置、凭证和 Memory 仍在账号层面共享。
未经配置时,内容工作区默认为 <runtime-home>/data/user/workspace。本地 PyPI、CLI 和源码安装可以在 Settings → Workspaces 中选择文件夹;使用以下命令设置默认文件夹:
deeptutor workspace show
deeptutor workspace set /absolute/path/to/my-folder
deeptutor workspace reset
各项能力通过内置的 workspace 工具查看所选的工作区。模型只会收到形如 outputs/... 的相对路径;当它使用 workspace_present 时,界面会渲染出一份可打开的、经过鉴权的快照。同样的相对路径在普通的 Markdown 链接或图片中也同样有效。之后修改源文件不会改变已经呈现过的快照。
学习空间负责管理资源库。在 Settings → Workspaces 中,可以为每个工作区分配 Skills、MCP 服务和知识库,或保留其现有访问规则。已有工作区会保持当前的访问权限,直到保存新的选择。分配直接引用原始资源,不会复制凭证或知识索引;工作区专属技能可以覆盖共享版本。详见工作区资源分配。
outputs/ 之外的执行是只读的。要把生成的文件复制到内容工作区内的其他位置,需要针对那个确切的源与目标显式确认一次允许一次。系统沙箱或 Docker runner 在可用时会强制执行这一边界;本地受限子进程回退方案在 Workspace 设置中会被标注为尽力而为。
方式一 — 从 PyPI 安装 · 完整本地 Web 应用 + CLI,无需克隆仓库
1.7.0 模块化安装: Web 应用与 CLI 使用 deeptutor[full],核心聊天使用 deeptutor。功能模块必须与核心版本一致;1.6.15 及更早版本使用旧的软件包布局。如需基于当前 dev 开发,请使用下方的源码说明,或构建本地 wheel。需要 Python 3.11–3.14 以及 PATH 中的 Node.js 20+ 运行时(打包的 Next.js 独立服务器由 deeptutor start 启动)。
mkdir -p my-deeptutor && cd my-deeptutor
pip install -U "deeptutor[full]"
deeptutor init # prompts for ports + LLM provider + optional embedding/search
deeptutor start # starts backend + frontend; keep the terminal open
deeptutor init 会提示配置后端端口(默认 8001)、前端端口(默认 3782)、LLM 提供商 / 基础 URL / API Key / 模型、可选的知识库 / RAG 嵌入提供商,以及可选的 Web Search 搜索提供商。
升级至 1.7.0: 停止应用并备份运行时主目录。运行 python -m pip install --upgrade "deeptutor[full]==1.7.0",然后执行 python -m pip check 和 deeptutor module list。如果安装了旧版 deeptutor-cli 包,请先运行 python -m pip uninstall deeptutor-cli,再执行升级命令(可选加上 deeptutor-cli==1.7.0)。旧 CLI 拥有共享的 Python 文件,在同一次事务中升级它可能会删除新的核心文件。卸载软件包会保留运行时主目录中的数据。继续使用相同的 DEEPTUTOR_HOME 和现有设置。1.7.0 中,单独运行 pip install -U deeptutor 只会选择核心包;请使用 [full] 请求完整应用安装配置。本地构建的软件包请遵循本地 wheel 升级说明。
deeptutor start 完成后,打开终端打印的前端 URL — 默认为 http://127.0.0.1:3782。在该终端按 Ctrl+C 可同时停止后端和前端。跳过 deeptutor init 也可用于快速体验;应用会以默认端口和空模型设置启动,稍后在 Settings → Providers 和 Language models 中配置即可。
浏览器麦克风转录: 兼容 OpenAI 的 STT 适配器会将浏览器音频直接转发给提供商,无需本地转换。原生 DashScope 和 Volcengine STT 适配器会将浏览器的 WebM/Opus 音频转换为 16 kHz WAV,要求 DeepTutor 的 PATH 中有可执行的 ffmpeg。符合规范的 16 kHz 单声道 PCM WAV 可跳过此转换。在 Windows 上通过 PyPI 安装且使用任一原生适配器时,请安装 FFmpeg,将其 bin 目录加入服务的 PATH,然后重启 DeepTutor。转换失败的信息会显示在聊天输入框下方。
方式二 — 从源码安装 · 基于代码仓库进行开发
适用于基于代码仓库的开发。使用 Python 3.11–3.14 和 Node.js 22 LTS 以匹配 CI 和 Docker 环境。
git clone --branch dev https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
# Create a venv (macOS/Linux). Windows PowerShell:
# py -3.11 -m venv .venv ; .\.venv\Scripts\Activate.ps1
python3 -m venv .venv && source .venv/bin/activate
python -m pip install --upgrade pip
# Install backend + frontend deps
python -m pip install -r requirements/full.txt
python -m pip install -e . --no-deps
( cd web && npm ci --legacy-peer-deps )
deeptutor init
deeptutor start --dev
deeptutor start 会为本地 web/ 前端构建一次生产版本并复用;--dev 则以热更新(HMR)方式运行 Next.js。配置布局、端口和 Ctrl+C 停止均与方式一相同。
Conda 环境(替代 venv)
conda create -n deeptutor python=3.11
conda activate deeptutor
python -m pip install --upgrade pip
可选安装额外依赖 — RAG 引擎 / dev / partners / matrix / math-animator
python scripts/install_extras.py rag-lightrag # Built-in LightRAG engine (exact supported SDK)
python scripts/install_extras.py graphrag # Microsoft GraphRAG engine (Python 3.11–3.13)
python scripts/install_extras.py dev # tests/lint tools
python scripts/install_extras.py partners # Partner IM channel SDKs
python scripts/install_extras.py video-learning # captions for reading/video-learning
python scripts/install_extras.py matrix # Matrix channel without E2EE/libolm
python scripts/install_extras.py matrix-e2e # Matrix E2EE; requires libolm
python scripts/install_extras.py math-animator # Manim addon; requires LaTeX/ffmpeg/system libs
python scripts/install_extras.py edge-tts # Optional free speech provider and video-lesson narration
Video Lesson: 在聊天中选择 Video Lesson,或运行 deeptutor run video_lesson "Explain a concept"。后端需要 Node.js 22+ 和 npm。首次使用会下载固定版本的 Remotion 软件包和 WebAssembly JavaScript 解释器,无需 Docker。帧检查在解释器内执行,无法访问宿主机文件系统、凭证、网络或进程 API,并受到内存与执行限制。取消操作会停止构建进程。本地与容器部署使用相同的执行路径,不会回退到无沙箱执行。生成的课程在浏览器中播放;可选旁白不可用时会显示字幕。
前端依赖调整与开发服务器故障排查
修改前端依赖: 运行 npm install --legacy-peer-deps 以刷新 web/package-lock.json,然后同时提交 web/package.json 和 web/package-lock.json。
开发服务器卡住: 如果 deeptutor start --dev 报告有已存在但无响应的前端进程,停止它打印的 PID。如果实际上没有 Next.js 进程在运行,则锁文件已过时 — 删除后重试:
rm -f web/.next/dev/lock web/.next/lock
deeptutor start --dev
方式三 — Docker · 单一自包含容器
单容器运行完整 Web 应用。镜像托管在 GitHub Container Registry:
ghcr.io/hkuds/deeptutor:latest— 最新稳定版本ghcr.io/hkuds/deeptutor:<version>— 不含前导v的精确版本(例如:1.6.3);预发布版本只会获得对应的版本标签
有关 podman / 无根容器 / 只读根文件系统部署及完整的每种安装指南,请参阅 CONTAINERIZATION.md。
docker run --rm --name deeptutor \
-p 127.0.0.1:3782:3782 \
-v deeptutor-data:/app/data \
ghcr.io/hkuds/deeptutor:latest
要在容器启动时选定宿主机上的内容文件夹,将其挂载到固定的容器路径,并把 DeepTutor 锁定到该路径:
mkdir -p "$PWD/deeptutor-workspace/outputs"
docker run --rm --name deeptutor \
-p 127.0.0.1:3782:3782 \
-v deeptutor-data:/app/data \
-v "$PWD/deeptutor-workspace:/workspace" \
-e DEEPTUTOR_WORKSPACE_ROOT=/workspace \
-e DEEPTUTOR_WORKSPACE_ALLOWED_ROOTS=/workspace \
ghcr.io/hkuds/deeptutor:latest
对于 Compose,在运行 python scripts/docker_compose.py up -d 前设置 DEEPTUTOR_WORKSPACE_HOST=/absolute/host/folder;省略时默认使用 ./data/user/workspace。Docker 路径在启动时就已选定,因此在 Web Settings 页面中会显示为已锁定。
只需发布
3782端口。 浏览器只与前端源通信;Next.js 中间件(web/proxy.ts)在容器内部将/api/*和/ws/*转发给 FastAPI 后端。发布8001(-p 127.0.0.1:8001:8001)是可选的 — 仅在需要用 curl 或脚本直接访问 API 时才有用。
打开 http://127.0.0.1:3782。容器首次启动时会创建 /app/data/user/settings/*.json;通过 Web Settings 页面配置模型提供商。配置、API Key、日志、默认内容工作区、记忆和知识库均持久化在 deeptutor-data 卷中。若单独挂载了内容工作区,则会持久化在其宿主机路径下。可选的额外依赖应配置在部署层面,而不是在 shell 中临时安装:设置 DEEPTUTOR_EXTRAS(系统库则用 DEEPTUTOR_APT_PACKAGES),由此启动的每个容器都会重新应用这些依赖;而 docker exec … pip install 这类临时安装会在下一次 compose down 后丢失。
- 不同宿主机端口: 修改每个
-p host:container映射的左侧(例如-p 127.0.0.1:8088:3782)。如果修改了/app/data/user/settings/system.json中容器侧的端口,重启并更新映射右侧以匹配。 - 后台运行: 添加
-d,然后用docker logs -f deeptutor查看日志,docker stop deeptutor停止,重用名称前执行docker rm deeptutor。deeptutor-data卷在重启之间保留私有运行时数据和默认内容工作区;单独挂载的内容工作区则持久化在其宿主机路径下。
远程 Docker / 反向代理: 浏览器只与前端源(:3782)通信;容器内的 Next.js 中间件在服务端将 /api/* 和 /ws/* 转发给后端服务器。对于常见的单容器场景,完全不需要配置 API base — 只需将反向代理 / TLS 终止器指向 :3782 即可。只有在拆分部署(后端在独立容器/主机上)时才需要设置 API base:将 data/user/settings/system.json 中的 next_public_api_base 设置为前端服务器用于访问后端的内网地址(它在服务端读取,永远不会发送到浏览器)。
{
"next_public_api_base": "http://backend:8001"
}
next_public_api_base_external(及其别名 public_api_base)作为低优先级的备用配置被接受。CORS 使用前端来源,而非 API URL。禁用认证时,DeepTutor 默认允许普通 HTTP/HTTPS 浏览器来源。启用认证时,需添加精确的前端来源:
{
"cors_origins": ["https://deeptutor.example.com"]
}
连接宿主机上的 Ollama / LM Studio / llama.cpp / vLLM / Lemonade
在 Docker 内部,localhost 指容器本身,而非宿主机。要连接宿主机上的模型服务,使用宿主机网关(推荐):
docker run --rm --name deeptutor \
-p 127.0.0.1:3782:3782 -p 127.0.0.1:8001:8001 \
--add-host=host.docker.internal:host-gateway \
-v deeptutor-data:/app/data \
ghcr.io/hkuds/deeptutor:latest
然后在 Settings → Providers 中,将提供商 Base URL 指向 host.docker.internal:
- Ollama LLM:
http://host.docker.internal:11434/v1 - Ollama 嵌入:
http://host.docker.internal:11434/api/embed - LM Studio:
http://host.docker.internal:1234/v1 - llama.cpp:
http://host.docker.internal:8080/v1 - Lemonade:
http://host.docker.internal:13305/api/v1
Docker Desktop(macOS/Windows)通常无需 --add-host 即可解析 host.docker.internal。在 Linux 上,该标志是在现代 Docker Engine 上创建该主机名的便携方式。
Linux 替代方案 — 宿主机网络: 添加 --network=host 并去掉 -p 标志。容器直接共享宿主机网络,打开 http://127.0.0.1:3782(或 system.json 中的 frontend_port),宿主机服务可通过普通 localhost URL(如 http://127.0.0.1:11434/v1)访问。注意宿主机网络会将容器端口直接暴露在宿主机上,可能与现有服务冲突 — 若需保持在回环地址上,可设置 BACKEND_HOST=127.0.0.1 和 FRONTEND_HOST=127.0.0.1(详见 CONTAINERIZATION.md)。
方式四 — 仅 CLI · 无 Web UI,基于源码安装
不需要 Web UI 时,可直接使用本仓库中的 CLI 并跳过 Node/npm。源码会提供所有已纳入仓库的模块,因此需要安装它们的 Python 依赖。若要采用 1.7.0 模块化版本进行最小化安装,请使用核心 deeptutor wheel,再单独添加功能模块。
git clone --branch dev https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
# Create a venv (macOS/Linux). Windows PowerShell:
# py -3.11 -m venv .venv-cli ; .\.venv-cli\Scripts\Activate.ps1
python3 -m venv .venv-cli && source .venv-cli/bin/activate
python -m pip install --upgrade pip
python -m pip install -r requirements/full.txt
python -m pip install -e . --no-deps
deeptutor init --cli
deeptutor chat
deeptutor init --cli 与完整应用共享同一 data/user/settings/ 布局,但跳过后端/前端端口提示。它仍会提供 Embedding 和 Search 选择器(不需要时选择 Skip),写入关键运行时文件(system.json、auth.json、integrations.json、interface.json、model_catalog.json、main.yaml、agents.yaml),并提示选择活跃的 LLM 提供商和模型。
常用命令
deeptutor chat # interactive REPL
deeptutor chat --capability deep_solve --kb my-kb
deeptutor run chat "Explain Fourier transform"
deeptutor run deep_solve "Solve x^2 = 4" --kb my-kb
deeptutor kb create my-kb --doc textbook.pdf
deeptutor memory show
deeptutor config show
此源码安装包含服务器依赖,但跳过前端配置。请保留源码仓库 — 可编辑安装指向它。若之后需要添加 Web UI,请安装 Node.js 22 LTS,在 web/ 中运行 npm ci --legacy-peer-deps,然后从项目根目录运行 deeptutor init 和 deeptutor start。
代码执行沙箱(Office 技能) · 运行 docx / pdf / pptx / xlsx 的模型生成代码
内置的 Office 技能 — docx / pdf / pptx / xlsx — 通过让模型编写一段简短的 Python 脚本(python-docx、reportlab、openpyxl 等),经唯一的 exec 工具运行,并呈现保存下来的工作区文件来完成工作。只要有沙箱后端处于激活状态,这些工具就会挂载。DeepTutor 按以下顺序选择已配置的最强后端:
- Runner sidecar:
DEEPTUTOR_SANDBOX_RUNNER_URL将执行路由至Dockerfile.runner提供的加固最小权限服务。 - Linux bubblewrap:
bwrap可用时,由它隔离进程和文件。 - 受限子进程回退: 本地和单容器安装仅在允许时使用此方案;在 Docker 下,容器仍构成另一层边界。
data/user/settings/system.json 中的 sandbox_allow_subprocess 设置(默认 true)只控制最后一种回退方案。将其设为 false(或导出 DEEPTUTOR_SANDBOX_ALLOW_SUBPROCESS=0),可在没有 runner 或 bwrap 后端时拒绝子进程执行;它不会禁用这些更强的后端。
配置参考 — data/user/settings/ 下的配置文件(JSON/YAML)
data/user/settings/ 下的所有内容均为纯 JSON/YAML 格式。推荐使用 Settings 页面进行编辑;工作区注册信息单独存储在 data/user/.runtime/workspaces.sqlite3 中。
| 文件 | 用途 |
|---|---|
model_catalog.json |
提供商连接,以及 LLM、任务、嵌入、搜索、TTS、STT、图像和视频配置、凭证与活跃选择 |
system.json |
后端/前端端口、公开 API 基础地址、CORS、SSL 校验、附件目录及上传/提取限制 |
auth.json |
可选认证开关、用户名、密码哈希、token/cookie 设置 |
integrations.json |
可选的 PocketBase 和 sidecar 集成设置 |
interface.json |
UI 语言与模型输出语言 / 主题 / 侧边栏偏好 |
document_parsing.json |
解析引擎与图像描述模型选择、远程端点与引擎专属选项 |
video_learning.json |
YouTube 字幕提供商、Invidious 来源与账号访问,以及转录设置 |
main.yaml |
运行时行为默认值和路径注入 |
agents.yaml |
能力/工具的 temperature 和 token 设置 |
Web Search 引用默认经过过滤:只会展示公开的 http/https URL,且不允许嵌入凭证或使用异常端口。部署者可以在 data/user/settings/system.json 中添加面向教育场景的域名策略:
{
"web_search_source_filtering": {
"enabled": true,
"blocked_domains": ["spam.example"],
"trusted_domains": ["edu.cn", "arxiv.org"]
}
}
当 trusted_domains 非空时,引用仅限这些域名及其子域;blocked_domains 始终拥有更高优先级。
项目根目录的 .env 不会作为应用配置文件被读取。最简模型配置:在 Settings → Providers 中保存 Base URL 和 API Key,然后在 Language models 中添加并选择一个 LLM。仅在计划使用知识库 / RAG 功能时才需要添加嵌入配置。
使用 API Route 时,在 Settings → Providers 中选择 API Route 并输入 API Route 密钥。预设地址为 https://global.api-route.com/v1;随后在 Language models 中使用 API Route 模型 ID 添加模型。密钥与模型的配置方法详见 API Route 快速入门。
如果提供商支持选择,LLM 和任务模型配置会提供 API format 设置。常规路由与回退请保留 Auto,也可选择 OpenAI Chat Completions、OpenAI Responses 或 Anthropic Messages;强制 Responses 模式仍会故障关闭。持久化字段为 api_format(auto、openai_chat、openai_responses 或 anthropic);wire_api 是派生的兼容性状态。每个模型均可通过 Auto / Supported / Not supported 覆盖工具调用、图像输入、JSON 输出和推理控制。
卸载与清理
DeepTutor 将已安装的代码、私有运行时主目录与可选的内容工作区三者分开。默认情况下,运行时主目录就是你运行 deeptutor init / deeptutor start 的目录;--home PATH 或 DEEPTUTOR_HOME 可以覆盖该位置。私有应用状态位于该目录内的 data 子目录,因此启动横幅中以 Workspace: 开头的行会标明这个运行时位置。如果 Settings → Workspace 指向了另一个文件夹,请单独备份或移除那个内容文件夹;卸载 DeepTutor 并不会清除它,这是刻意的设计。
停止应用。在运行
deeptutor start的终端中按Ctrl+C;若启动器通过--detach启动,则运行deeptutor stop [--home PATH]。删除数据前,还应停止所有正在运行的 Partner 和后台 Docker 容器。只有在确实要清除所有本地状态时,才移除运行时数据。其中包括设置和 API Key、聊天历史、会话、Memory、Notebooks、Books、Reading 状态、Skills、Partners 状态、日志、Knowledge Bases、解析缓存、生成的产物以及打包的前端运行时缓存。
先从启动横幅中复制精确的
Workspace:路径,并确认其data子目录就是要处理的 DeepTutor 数据目录。如有任何内容之后可能还会用到,请先备份,再将这个精确目录移入操作系统的废纸篓/回收站。不要对相对路径或尚未解析的环境变量执行递归删除命令。移除已安装的软件包。根据发行版运行对应命令:
python -m pip uninstall deeptutor python -m pip uninstall deeptutor-cli如果虚拟环境仅供 DeepTutor 使用,请通过环境管理器将其移除。对于源码安装,先退出该环境并离开源码目录,再在那个精确的代码仓库中运行
git status --short。只有确认其中没有无关文件或未提交工作后,才能将代码仓库移入废纸篓/回收站。对于 Docker 安装路径,请先检查确切的容器和命名卷,再执行移除。删除卷会永久清除由 Docker 管理的数据:
docker ps -a --filter name=^/deeptutor$ docker volume inspect deeptutor-data docker rm -f deeptutor docker volume rm deeptutor-data
📖 探索 DeepTutor
先为一个学科或项目建立工作区。其中的主页、学习和资源分别承载对话、学习活动和素材。Partners 和个性化随账号在不同工作区之间共享。下方导览展示这些界面如何衔接,随后介绍设置与多用户部署。
如果回答遗漏了先前的约束、引用了薄弱证据,或与选定素材不一致,请先按照 REASONING_SAFETY_CHECKLIST.md 收集诊断信息,再提交 Issue。
🏗️ 系统架构
💬 Chat — 真正好用的智能体循环
Chat 是默认能力,也是大多数工作的起点。单个对话线程可以正常交流、调用工具、基于选定知识库进行检索、读取附件、生成图像、调用子智能体、写入笔记本记录,并在多轮对话中保持相同的上下文。
导师会按需调用工具,也可以暂停并提出澄清问题。右上角的自定义页面用于选择可见的模式,以及技能、MCP、Partners、偏好和语音输入控件。在起始提示下,可添加、编辑或移除解释、解题、练习、规划和研究的标题与提示。保存会应用账号偏好;取消会放弃编辑,恢复默认值则还原最初的选择。
用户可切换的工具有 brainstorm、web_search、paper_search、zotero_search、reason 和 geogebra_analysis — 配置了对应生成模型后还有 imagegen 和 videogen。上下文工具如 rag、kb_files、knowledge_frontier、read_source、read_memory、write_memory、read_skill、load_tools、exec、web_fetch、ask_user、list_favorites、save_favorite、write_note、search_notes、question_bank、github、consult_subagent、workspace_list、workspace_read、workspace_search、workspace_present 和 workspace_export 会在当前轮次具备相应上下文时自动挂载。
上下文分为两类:粘性会话上下文(能力、工作区或课程、工具、知识库、人格预设、模型,以及 Reading / Mastery 状态)会在各轮次间持续保留;一次性引用(文件、聊天历史、书籍、阅读章节、笔记本、选中的题库条目、导入的智能体)通过 + 菜单添加,仅用于单次对话轮次。语音按钮只会转录当前消息。
使用完整安装配置时,主页让 Chat、Ask Questions、Quiz、Visualize 和 Video Lesson 一键可达;用于生成引用报告的 Research 和用于展示完整推理过程的 Solve 位于更多能力之下。学习 → 新建学习位于“全部学习”上方,会打开专门的页面,提供 Book、Mastery Path、Immersive Reading 和练习。页面上的自定义页面控件可以隐藏或恢复学习方式,而不改变已有记录;不可用的模块仍不会显示。Reading 将文档、视频和音频整合在一起,提供经过验证的引用、已保存的笔记、来源段落 / 学习指导 / 词汇 / 测验 / 翻译操作的自然朗读,以及笔记本摘录。
🤝 Partner — 运行在同一大脑上的持久伴侣
Partners 是拥有独立灵魂、模型策略、知识库、记忆和渠道的持久伴侣。它们不是独立的机器人引擎:每条入站的 Web 或 IM 消息都会成为在其私有或绑定的内容工作区内的一次普通 ChatOrchestrator 对话轮次。Partner 就是"一个有个性和电话号码的聊天"。
每个 Partner 拥有 SOUL.md、模型选择、渠道、工具策略和分配的知识库。其资源库可以将知识库、技能和收藏夹集合复制到 data/partners/<id>/workspace/,也可以保持与已有工作区的文件和资源链接;灵魂、对话和 Partner 记忆仍保持独立。经过认证的非管理员用户拥有私有的 Partner 会话和关系记忆,而 Partner 只读访问其个人记忆;管理员、群组和未绑定流量则使用共享的 Partner 作用域。
渠道层基于 Schema 驱动,根据已安装的额外依赖和配置的凭证,可连接飞书、Telegram、Slack、Discord、钉钉、QQ/NapCat、企业微信、WhatsApp、Zulip、Mattermost、Matrix、Mochat 和 Microsoft Teams 等 IM 平台。Partner 也可以作为子智能体连接,并从普通聊天轮次中调用 — 详见下方的我的智能体。
为加快配置,Partner 渠道页面可以直接在浏览器中绘制二维码(而非依赖服务器日志)来创建飞书/Lark 应用或企业微信 AI 机器人,或扫码登录个人微信账号。飞书/Lark 会检测账号所属域名,并将扫码用户保存为初始允许的发送者。企业微信会保留已有的白名单,否则默认允许所有能触达机器人的用户使用,并显示明显的开放访问警告;如果某个平台的扫码协议发生变化,手动渠道配置表单仍然可用。
🧑🚀 我的智能体 — 调用与导入其他智能体
"我的智能体"将其他智能体转化为 DeepTutor 的上下文,具备两种不同的功能。连接实时智能体 — 连接你机器上的 Claude Code、Codex、Grok CLI、Antigravity、Kimi、opencode、MiMo Code、Hermes Agent、OpenClaw 或 DeepSeek Harness、远程 Hermes 网关,或你的某个 Partner,在聊天轮次中调用它:DeepTutor 实际上会运行另一个智能体,并通过 consult_subagent 工具将其工作流式传输到 Activity 面板。使用 Agent 芯片选择智能体及其轮数上限,或通过 @ 筛选同一份已连接智能体列表;所选配置会随会话保留。
连接 Grok CLI。 在运行 DeepTutor 后端的机器上安装 xAI 的 Grok CLI,在该机器上运行 grok login,并确认 grok --help 列出了 --output-format streaming-json。然后打开 My Agents → Connect,选择 Grok CLI,并选定工作目录。检测只核实该可执行文件对协议的支持,不校验登录状态或模型访问权限。此连接器已在 Grok CLI 1.0.3 上验证;名字同样叫 grok 的无关第三方命令不受支持。
在 Settings → Partners & Agents → Grok CLI 中,将模型和推理强度留空即使用 CLI 自身默认值,或填入你账号的 grok models 输出中支持的值。系统指令通过 --rules 传入。默认权限模式为 dontAsk:Grok 使用其现有规则和内置的只读处理,并拒绝需要审批的操作。这是一项 CLI 权限策略,而非文件系统沙箱。可以在设置中显式选择更宽松的模式;高级 CLI 参数仍可通过智能体设置 API 中的 backends.grok.extra_args 使用。
Grok 使用自己的认证和会话存储;DeepTutor 不会复制其凭证。后续调用会在同一工作目录中恢复该连接的会话。文本与工具活动会实时流式呈现;私密思考内容会被省略。跨会话的 Grok 记忆默认关闭。此连接器支持文本问答和 CLI 工具,不支持转发图片或导入 Grok 过往对话。在 Docker 中,请在后端容器内安装并完成 Grok 的登录认证;只安装在浏览器所在机器上的 CLI 是无法访问的。
导入历史对话 — 将已有的 ChatGPT、Claude Code 和 Codex 历史记录作为可搜索、可续聊的对话导入。选择官方 ChatGPT 数据导出中的 conversations.json,即可完成一次安全、幂等的快照式导入;Claude 历史按项目 / 工作目录选择,Codex 历史按日历日期选择。基于文件夹的智能体仍可刷新,让其所选范围拉取新对话。在 Chat 轮次中通过 + → 我的智能体引用其中一段对话,DeepTutor 会将其作为第三方对话记录读取 — 它始终是对方的对话,而不是 DeepTutor 自己的口吻。
✍️ 学习笔记本 — 页面、来源与 Dito
学习笔记本的前身是 Co-Writer,它在当前工作区内将你的写作组织为页面、子页面和内容块。你可以导入 Word 文档、编排页面树,并将收藏夹中的原始记录作为证据插入。页面始终显示保存状态,可导出为 Markdown 或 Word;交互内容在 Word 中会转为静态内容。
与 Dito 讨论某段文字或某个内容块:请它解释、举例、改写,或生成练习题。对话始终附着在相应页面和行上。接受前先审阅修改建议,也可将答案插入该行下方后继续写作。收藏夹保留来源记录,笔记本则是你构建自己理解的地方。
📖 Book — 从你的素材生成活书
Book 将选定的来源转化为交互式活书 — 不是静态 PDF,而是由类型化块构建的阅读环境。书籍可以从知识库、收藏夹、题库或聊天历史开始创建;创建流程会在内容生成前提出章节大纲,让你审查结构,而不是被动接受一次性的盲目输出。
每章会编译为可编辑的类型化块 — 文本、标注、测验、闪卡、时间轴、代码、图形、交互式 HTML、动画、概念图、深度解析和用户笔记 — 并拥有自己的 Page Chat。你可以插入、移动、重新生成、改写或切换块类型;选中的段落会进入可审核的学习摘录收件箱。即使管理员将书籍共享为只读或协作编辑,每位读者的学习进度、书签、测验作答、学习摘录和 Page Chat 仍保持私有;共享书籍只能由管理员删除。任何书籍都可导出为 Markdown,长时间编译可暂停并恢复,deeptutor book health / refresh-fingerprints 会标记来源漂移。
📚 知识中心 — 多引擎 RAG 知识库
知识库是 RAG 背后的文档集合 — 为 Chat 对话、学习笔记本编辑、Book 生成和 Partner 对话提供依据。其独特之处在于检索引擎的选择:LlamaIndex(默认,混合向量 + BM25,可选交叉编码器重排序及 exact-flat 或 HNSW FAISS 索引)、PageIndex(支持页面级引用的推理检索,托管或自托管 OSS)、GraphRAG 和 LightRAG(知识图谱检索)、LightRAG Server(将检索卸载至你通过 HTTP 连接的外部 LightRAG 实例)、WeKnora(从你的自托管部署中的知识库检索,无需本地索引或复制文档)、Tencent IMA(在 IMA 中维护的知识库 — 通过其 OpenAPI 进行检索、浏览并写回),MarginNote 4(你的 MN4 学习数据 — 文档、摘录、脑图卡片及其相互链接 — 由该应用的插件推送进来,并通过专用工具进行导航)、Kiwix(通过 HTTP 提供的可搜索 ZIM 归档,无需本地索引),或直接在原位读写的链接 Obsidian vault。每个 KB 绑定到单一引擎。
要迁移现有的 Obsidian、Hermes 或 Markdown 资料库?请参阅知识迁移指南,了解连接 vault 与索引副本两种路径。
创建 KB 时,可以选择新建(上传文档并构建索引)、链接已有(原位复用索引),或连接 Kiwix(按需搜索一个通过服务提供的 ZIM 归档)。创建时可选择其存储工作区;已有知识库可在预览后移至其他工作区,同时保留资源分配和已保存的引用。知识库还可以追踪 GitHub 仓库(仓库、分支和 glob 匹配模式)或文档站点 URL(限制爬取深度和页面数量,默认每 24 小时重新同步一次);同步时会通过内容哈希差异识别新增、变更和移除的内容,让你关注的文档保持最新,无需重新上传,链接文件夹也会在同步时拾取新增或变更的本地文件。重新索引会写入新的平铺 version-N 目录并保留旧版本,因此重建过程中现有索引不会被破坏。即使知识库处于 error 状态,也可以单独移除其中一份文档 — 无需完整地删除重建,就能丢弃解析失败的文件。文档解析 — 纯文本、MinerU、Docling、Tika、markitdown、PyMuPDF4LLM 或 LiteParse — 以及可选的图像描述模型均在 Settings → Knowledge & documents 中选择,本地模型下载默认关闭。Docling 也可以以 remote 模式运行,对接 Docling Serve 服务器(无需本地安装或模型),可在该页面中配置(mode=remote、服务器 Base URL 和可选的 API Key),或通过 DOCLING_MODE / DOCLING_API_BASE_URL / DOCLING_API_TOKEN 环境变量配置。Tika 仅支持远程模式,需指向该页面中配置的 Apache Tika 服务器。CLI 通过 list/info/create/connect-kiwix/add/search/eval/eval-diff/set-default/delete、来源添加/移除命令、list-sources 和 sync 管理完整生命周期。
内置的 LightRAG 引擎通过 pip install 'deeptutor[rag-lightrag]' 安装。该额外依赖包含受支持的 LightRAG SDK,但不会安装 MinerU。如需结构化解析,请在文档解析中单独选择 MinerU,并配置其云端模式或安装当前的本地 CLI。MinerU 支持 PDF、常见的光栅图像、DOCX、PPTX 和 XLSX;旧版 magic-pdf 命令仍仅支持 PDF。纯文本及其他解析引擎均不需要 MinerU。
原生 LightRAG 的查询与增量索引依赖已发布索引所记录的嵌入配置,包括模型、维度和端点身份。如果该配置发生变化,需要恢复原始配置,或使用当前嵌入重建索引;未记录嵌入身份的索引则必须重建。知识库详情页和索引版本视图会显示恢复指引,同时文件仍可正常查看和下载。
评估知识库。 有多个引擎可选时,“哪一个在这里检索得最好?”需要通过实测回答,deeptutor kb eval 正是为此而设。编写一个 QA 数据集(每行一个 JSON 对象,包含 query 和理想检索应返回的 gold 段落),然后使用 deeptutor kb eval <name> --dataset qa.jsonl --top-k 5 [--mode hybrid] [--save baseline.json] 为知识库评分。每个样例均通过聊天轮次所用的同一路径检索,按排序返回的引用会通过精确文本匹配或词汇重叠与标准段落进行匹配(可用 --min-ratio 调整阈值;不评估语义等价),运行结果报告 Recall@k / Precision@k / nDCG@k / MRR / MAP / Hit@k。各指标都是对排序结果计算的纯函数,无需模型裁判。使用 deeptutor kb eval-diff baseline.json candidate.json 比较已保存的报告,查看各指标和各样例的变化。在 kb eval 中使用 --rewrite off 或 --rewrite standalone,可比较原始查询与改写后的查询;报告会保留查询改写记录。检索失败的样例(如缺少索引或凭证有误)不计分,会单独报告,不会拉低平均值。PageIndex 以推理进行检索,不返回有排序的文本块,因此不在评估范围内。
{"query": "Why do transformers scale attention?", "gold": ["Scaling keeps the dot products from growing with the dimension."]}
🌐 资源与个性化 — 素材与可复用的辅助能力
资源汇集聊天历史、支持移动记录和 Markdown 导出的收藏夹、学习日志、知识中心,以及保存答案与解析的题库。可以从题库选区或学习 → 练习启动练习,进行复习会话、错题追踪和定期复习。独立的个性化页面包含人格预设、技能(SKILL.md 剧本)、一键使用的 MCP 服务,以及来自 CLI-Anything 目录的 CLI 应用,每个应用的使用指南按需加载。学习汇集书籍、掌握度路径、阅读集合及其导师对话;每项素材只会出现在支持它的工作流中。
你不必自己编写每个技能 — 从 EduHub 导入可浏览社区目录,通过安全门将技能直接下载到你的库中(详见生态系统)。
🧠 Memory — 可审计的个性化记忆
Memory 是一个基于文件、三层结构的系统,你可以读取、整理和审计它 — 刻意设计为非隐藏的向量库。L1 是工作区镜像加仅追加的事件追踪(trace/<surface>/<date>.jsonl);L2 是按表面整理的事实(L2/<surface>.md),包含对 L1 实体的引用;L3 是跨表面的综合(L3/<profile|recent|scope|preferences>.md),记录参与综合的 L2 表面层。
Memory Graph 展示整个金字塔 — L3 综合位于中心,L2 在中间圆环,L1 追踪在外圈 — 并显示精确的 L2 → L1 证据边和 L3 → 参与表面层链接。Memory 在 chat、notebook、quiz、kb、book、partner 和 cowriter 表面进行追踪;整合器的更新 / 审计 / 去重预算可在 Settings → Memory 中调整。
⚙️ Settings — 统一的控制面板
Settings 是操作控制面板,首页通用用于设置界面与模型输出语言。可搜索的导航栏链接到各个独立页面:个人包括工作区、数据迁移、外观和用量统计;学习与对话包括起始建议、附件、Video Learning、学习者与监护人控制、学习进度,以及 Memory;模型与服务包括提供商、语言模型、任务模型、嵌入、搜索、语音和多模态生成;功能与集成包括工具、能力参数、Partners 与智能体以及知识与文档。系统包括网络、运行状态和关于;已归档对话支持搜索、恢复或永久删除归档的对话。运行状态展示后端健康状况、常驻内存占用,以及评估能力阻断项、警告和建议的就绪度(Readiness)矩阵。工作区将主题文件和学习状态分开,数据迁移提供经过验证的迁移和导出。提供商保存厂商地址和凭证,供其服务模型复用;模型页面选择已保存的提供商,并配置模型名称和能力。任务模型为后台工作(如给会话命名、撰写起始建议)指定一个小而快的模型,留空时则回退到当前默认模型。语音汇集语音合成与转录;多模态生成汇集图像与视频模型。Partners 与智能体用于配置本地智能体运行框架和远程 Hermes 网关。
Xiaomi MiMo 语音。 添加 Xiaomi MiMo 提供商,填写 https://api.xiaomimimo.com/v1 和 API Key,然后在 Settings → Voice 中添加 mimo-v2.5-tts。选择 mimo_default、冰糖 或 苏打 等预设音色,使用 wav 或 pcm16 输出,并在应用前试听。语音指令可控制风格和语速。该适配器仅支持预设语音;声音设计与声音克隆需要独立模型,目前不受支持。如果旧的 MiMo 语音模型通过通用的 OpenAI 兼容适配器配置,请使用 Xiaomi MiMo 提供商重新创建语音条目,使其采用 chat-completions 协议。详见 MiMo 官方语音指南。
MiniMax 语音 — 在 Settings → Voice 中,将文本转语音提供商选为 MiniMax,并选择 speech-2.8-hd。配置 MiniMax API Key,并明确选择系统音色或输入自定义音色 ID。API 基础地址默认为 https://api.minimax.io/v1;中国地区使用 https://api.minimaxi.com/v1。朗读与音色预览使用原生语音端点,支持 MP3、WAV、FLAC 或 PCM 输出,以及采样率、语速和语言控制。音色 ID 和账号可用性详见 MiniMax 语音 API。
Settings → Learning & conversation 下的 Video Learning 为 Reading 配置 YouTube 字幕和 Invidious 访问。使用 Invidious 时,请设置由管理员管理的后端 API 来源(例如 http://127.0.0.1:3000)和浏览器可访问的公开来源,测试连接后选择 Invidious 并保存。Reading 添加素材对话框中的 Browse Invidious 可搜索视频,并访问已连接的订阅和播放列表。YouTube 播放使用官方隐私增强型播放器;字幕缺失时会明确显示,并限制导师可用的证据,但不会阻止原生播放。在源码仓库中,运行 python scripts/install_extras.py video-learning 可使用默认的 YouTube 字幕加载器。已有 Watching 链接会迁移到 Reading,保留对话历史、兼容的转录、笔记和进度;新的时间戳笔记会保存为 Reading 批注。Bilibili 使用独立的播放和字幕路径。
大多数部分采用草稿-应用流程,因此你可以在提交前测试提供商配置。你也可以直接在 Chat 中开口:助手会读取当前配置、应用变更,并告知是否需要重启或重新索引 — 在提交前先探测新模型,因此它不会把自己切换到不可达的配置上。API Key 永远不会经过模型 — 它会为你打开对应的表单来输入。开箱即提供四种主题 — Default、Cream、Dark 和 Glass。项目根目录的 .env 文件被刻意忽略;运行时配置存储在 data/user/settings/*.json 下,除非 DEEPTUTOR_HOME 或 deeptutor start --home 将应用指向其他位置。
OpenAI Codex OAuth(实验性)。 在 Settings → Providers 下添加 OpenAI Codex,会打开基于你自己 ChatGPT 订阅运行的浏览器登录,因此无需 OPENAI_API_KEY。令牌仅保存在 data/system/user-secrets/<owner>/private/openai-codex/ 中 — 在多容器 Compose 部署中,位于 exec 沙箱可触及的所有目录树之外 — DeepTutor 绝不会读取或修改你的 ~/.codex CLI 登录状态。模型列表来自该账号的实时目录;登录会发布模型配置,但只有尚未配置任何 LLM 时,它才会成为活跃模型。令牌只授权一个人的订阅,无法通过用户授权共享,因此每个账号都需自行登录 — 普通用户也不例外:他们的登录卡片位于 Providers 下,产生的模型、目录和退出登录操作均只对该账号私有。
在登录和刷新模型时,DeepTutor 会从官方 npm 注册表读取最新的稳定版 @openai/codex 版本号,并将其用作目录请求的 client_version。这仅是元数据操作:它不会安装、下载或升级 Codex CLI,该 npm 请求也不携带任何 OAuth 凭证。发现过程有三秒的时限和 64 KiB 的响应大小上限。如果失败,DeepTutor 会使用该账号上次成功获取的版本号,若没有缓存则使用内置的回退版本。只有成功解析的实时目录才会保存新版本号;验证器绝不会在不同版本或不同凭证世代之间被复用。版本被拒绝或目录结构不兼容时,允许用上一个版本重试一次;认证失败、限流和 TLS 失败不会被当作版本问题重试。手动刷新失败时会报告错误,而不会把旧的缓存目录当作刷新结果呈现。
成功的版本历史记录能在同账号令牌续期和目录认证错误之后继续保留,但不会让已失效的模型数据或 ETag 重新变得可用。退出登录会清除该账号的本地缓存,包括版本历史记录。普通的状态读取和推理调用不会查询 npm。目录中出现的新条目不会替换你已经选定的模型,也不会重启学习会话;出现在目录中并不代表已建立完整的推理协议兼容性。目前没有后台版本自动更新器,也没有用户可设置的版本选项。
默认的本地 Docker 和 Podman 部署各自使用独立的回环网络,登录时需要一个临时桥接。具体的 Docker、Compose、Podman 及拆除命令请参阅临时本地 Codex OAuth 桥接指南。
远程部署时,浏览器的 localhost 和服务器的 localhost 不是同一台机器,仅有普通反向代理无法把浏览器的 localhost callback 送到服务器,必须用 SSH 隧道建立 callback 桥。隧道通向已发布的 Web 端口;Next.js 只把精确的 callback 路径改写到 public callback broker,broker 校验 state 后才路由到原 OAuth operation。callback listener 仍位于后端 loopback,不发布 1455/1457,并支持默认 Docker bridge 网络。
ssh -N -L 1455:127.0.0.1:3782 <ssh-user>@<server-host>
若 DeepTutor 显示 fallback callback 端口 1457,则使用:
ssh -N -L 1457:127.0.0.1:3782 <ssh-user>@<server-host>
只运行与实际 callback 端口对应的其中一条命令,不能两条都运行。3782 只是示例 Web 端口:它是 DeepTutor 配置并作为 callback_forward_port 显示的 frontend/container 端口,不保证 SSH 主机的 127.0.0.1 正在监听同一端口。若 Docker/Podman 映射到不同宿主机端口,或反向代理监听不同端口,只替换 SSH 命令右侧的目标端口(上例中的 3782)为 SSH 主机 127.0.0.1 实际监听的 Web 端口;左侧 callback 端口仍保持 1455 或 1457。<server-host> 是该 loopback 监听端口所在的 SSH 主机;若浏览器域名指向反向代理或负载均衡器,请替换为正确的 SSH 前端主机。
CLI 会先打印隧道命令,随后立即尝试打开浏览器。远程用户应先保持授权页打开但不要完成授权,在另一终端建立所显示的隧道,然后再继续授权。
localhost 检测存在边界:若 Web 本身已通过 SSH 或 IDE localhost 转发访问,浏览器无法判断服务器是远程的。对于当前 Web operation,应保持其授权页未完成,从该 operation 的 authorize URL 中读取 redirect_uri,确认 callback 是 1455 还是 1457,再把该本地端口通过第二条隧道转到实际 Web 端口。另一种方法是取消该 Web operation,再通过 CLI 启动一个新 operation;CLI 输出只属于新 operation,不能用于当前 Web operation。配额错误和目录获取失败会如实报告,绝不会回退到付费提供商。此兼容路径为实验性功能:上游接口可能发生变化。
👥 多用户 — 共享部署 · 可选认证,隔离的用户工作区
认证默认关闭 — DeepTutor 以单用户模式运行。开启后,单个 data/ 目录树可同时托管管理员工作区、隔离的用户工作区和 Partner 工作区:
data/
├── user/ # Admin workspace + global settings
├── users/<uid>/ # Per-user scope: chat history, memory, notebooks, KBs
├── partners/<id>/workspace/ # Partner (synthetic-user) scope
├── cli-apps/ # Installed CLI apps, mounted read-only into the sandbox
└── system/ # auth · grants · audit · user-secrets/<owner> (OAuth tokens)
第一个注册用户成为管理员,拥有模型目录、提供商凭证、共享知识库、技能、共享书籍主副本和用户授权的管理权。由管理员创建的本地用户可选择 Standard、Learner 或 Custom。Learner 会锁定学习能力与素材策略,加入自适应档案,并支持带有效期和每日限额、可撤销的设备凭证;获授权的监护人可以查看报告、批准素材和重置凭证。其他用户拥有隔离工作区,以及受作用域约束的模型、知识库、技能、Partners 和共享书籍访问权,但不会获得原始 API Key。如果 auth.json 已包含 username + password_hash,该账号就是管理员:/register 会保持关闭,而从 /admin/users 创建的账号始终为 role=user,直至你将其提升。
启用方式: 在 data/user/settings/auth.json 中开启认证,重启 deeptutor start,在 /register 注册第一个管理员,然后从 /admin/users 添加用户,并通过授权分配模型、知识库、技能、Partner、工具/MCP/CLI 应用策略和代码执行权限;在每个用户的 Book access 面板中配置共享书籍。
对于拆分私有/公开来源的部署,将 auth.private_login_hosts(或 AUTH_PRIVATE_LOGIN_HOSTS)设为可以展示密码登录与注册的私有前端主机列表。前端会把收到的 HTTP Host 作为其前端主机断言转发给后端。请通过反向代理保留浏览器原始的 Host,并让公开入口拒绝声称是私有主机的请求;不要暴露一个会接受任意 Host 值的裸 Next.js 端口。HTTP Host 可以被直连客户端伪造,因此私有主机的授权依赖于这道入口边界。后端默认只接受来自 loopback 的前端主机断言。如果 Web 前端是从另一个容器或主机连接过来的,请在后端进程上将 AUTH_TRUSTED_FRONTEND_PROXY_IPS 设为该前端代理的精确 IP 地址(多个时用逗号分隔)。这会替换默认值;如果也需要本地前端连接,请加入 127.0.0.1,::1。保持后端 API 只对该前端代理私有,不要在此列表中包含笼统的客户端网段。当 private_login_hosts 非空时,私有来源上已认证的用户可以打开 Profile → Public device sign-in,为某个 HTTPS 公开来源创建一条短时有效、绑定主机的配对链接。公开的 /handoff 页面会在一次 POST 请求体中用一次性代码换取一张同样短时有效的 JWE 票据,消费该票据一次,并获得正常的 HttpOnly 会话 Cookie。
PocketBase 仍为单用户集成 — 多用户部署时请将
integrations.pocketbase_url留空,除非你已接入外部用户存储。
⌨️ DeepTutor CLI — 智能体原生界面
一个 deeptutor 可执行文件,两种使用方式:供习惯在终端中工作的人使用的交互式 REPL,以及供将 DeepTutor 作为工具来驱动的其他智能体使用的结构化 JSON 输出。两种方式共享相同的能力、工具和知识库。
自己驱动
deeptutor chat 打开交互式 REPL,并通过 --capability 选择模式;deeptutor run <capability> "<message>" 将能力作为第一个位置参数,并在执行一个轮次后退出。两者均接受 --tool、--kb、--config,以及用于选择已注册工作区的 --workspace。
deeptutor chat # interactive REPL
deeptutor chat --capability deep_solve --kb my-kb
deeptutor run chat "Explain the Fourier transform" --kb textbook
deeptutor run chat "Find recent work beyond this material" --kb textbook
deeptutor run deep_research "Survey 2026 papers on RAG" \
--config mode=report --config depth=standard
--kb 为自动挂载的 RAG 和 Knowledge Frontier 工具提供上下文;Frontier 同时需要 knowledge 和 research 模块。--tool 用于选择用户可切换的工具。已启用的模块还会提供知识库、会话、Partner、技能、笔记本、记忆和配置命令。
让智能体驱动
DeepTutor 专为被其他智能体操作而设计。在任何 run 命令中添加 --format json,每个轮次将流式输出 NDJSON — 每行一个事件(content、tool_call、tool_result、done 等),每行带有其 session_id 标记。运行是无头安全的:无 TTY 时,ask_user 暂停会以空回复自动解决,而不是挂起。
# One shot, machine-readable
deeptutor run deep_solve "Find d/dx[sin(x^2)]" --tool reason --format json
# Chain turns in one stateful session — capture the id, reuse it
SID=$(deeptutor run deep_research "Survey 2026 papers on RAG" \
--config mode=report --config depth=standard --format json \
| jq -r 'select(.type=="done").session_id')
deeptutor run deep_question "Quiz me on that survey" --session "$SID" --format json
仓库根目录附带 SKILL.md — 一份简洁的 CLI 交接文档。请明确要求你的智能体阅读它;其智能体配置指南 涵盖安装与配置。你也可以将 deeptutor run 包装为 LangChain / AutoGen 循环中的工具。完整示例:Agent Handoff。
命令参考
下表涵盖完整安装与可选扩展;命令和能力需要启用相应模块。核心包提供 chat 和 ask_questions。
| 命令 | 说明 |
|---|---|
deeptutor init [--non-interactive] [--home PATH] |
运行配置向导,或无需提示地创建缺失的默认配置 |
deeptutor doctor [--online] |
检查运行时是否已准备好启动会话;--online 还会探测已配置的模型提供商,--format json 打印报告 |
deeptutor start [--home PATH] [--dev] [--detach] [--no-browser] |
同时启动后端 + 前端;可选择后台运行或禁止自动打开浏览器 |
deeptutor stop [--home PATH] |
停止通过 --detach 启动的启动器 |
deeptutor serve [--port PORT] |
仅启动 FastAPI 后端 |
deeptutor module list/install/uninstall/enable/disable |
查看模块,并在 DeepTutor 停止后进行变更;源码仓库支持启用/禁用 |
deeptutor workspace show/set/reset |
查看、选择或还原当前用户的内容工作区 |
deeptutor run <capability> <message> |
运行单次能力对话(chat、ask_questions、deep_solve、deep_question、deep_research、visualize、math_animator、video_lesson、mastery_path、immersive_reading、audio_overview);添加 --format json 可获得 NDJSON 输出 |
deeptutor chat |
交互式 REPL,支持能力、工具、知识库、笔记本和历史控制 |
deeptutor partner list/create/start/stop |
管理 IM 连接的 Partners |
deeptutor kb list/info/create/connect-kiwix/add/search/eval/eval-diff/set-default/delete/list-sources/sync |
管理知识库、连接 Kiwix 归档、评估并比较检索运行结果,并同步已注册的 GitHub/Web 来源(包含来源添加/移除命令) |
deeptutor skill search/install/list/remove/login/logout/publish/update |
管理技能、从 Hub 安装并发布自己的技能(默认 eduhub:<slug>,详见生态系统) |
deeptutor memory show/clear |
查看 L2/L3 记忆文档或清除 L1/全部记忆 |
deeptutor session list/show/open/rename/delete |
管理共享会话 |
deeptutor notebook list/create/show/add-md/replace-md/remove-record |
从 Markdown 文件管理笔记本 |
deeptutor book list/health/refresh-fingerprints |
查看书籍并刷新来源指纹 |
deeptutor plugin list/info/state/search/show/install/approve/enable/disable/rollback/uninstall |
查看工具与能力;管理经过审核的插件包及其权限审批 |
deeptutor config show [--home PATH] |
显示已解析的运行时配置,并隐去凭证 |
deeptutor config providers |
以 JSON 列出配置时支持的提供商及其默认值 |
deeptutor config apply FILE [--check] [--home PATH] |
无需提示地应用配置 JSON,或只验证而不写入设置 |
deeptutor provider login <provider> |
提供商认证(openai-codex OAuth 登录;github-copilot GitHub 设备登录;codebuddy 验证 CodeBuddy SDK 认证并在需要时启动登录) |
GitHub Copilot 凭证属于已登录的 DeepTutor 所有者,仅保存在
<runtime-home>/data/system/user-secrets/<owner-id>/private/github-copilot/credentials.v1.json,
位于沙箱工作区之外。CLI/管理员的 Partners 使用管理员凭证;
其他用户需单独登录,Copilot 配置不能通过模型授权共享。
外部 nanobot/Copilot 令牌文件绝不会被导入:升级后,请重新运行
deeptutor provider login github-copilot。
登录会使用当前发现的模型验证推理;init 验证所选模型,
失败时中止且不保存配置草稿。仅成功完成 GitHub
认证并不代表获得 Copilot 模型访问权限(即使验证失败,已保存的登录仍会保留)。
运行时请求遵循令牌交换返回的 API 端点,包括刷新后的端点,
并遵守各模型的 Responses/Chat Completions 端点元数据。
Copilot 专属的 Responses 兼容处理在分发请求时应用,不会改写已保存的历史记录。
仅 CLI 发行版
核心 wheel 提供 CLI 和 SDK;deeptutor-cli 是兼容性元包。源码会提供所有已纳入仓库的模块,因此使用 CLI 时,请安装这些模块的 Python 依赖并跳过前端配置:
python -m pip install -r requirements/full.txt
python -m pip install -e . --no-deps
如需最小化安装,请使用核心 wheel。可选发行包提供工具、能力、API 路由、后台服务和导航。模块共享同一个 Python 环境,并且必须与核心版本一致。deeptutor[full] 会在安装时选择常用应用模块;之后仍可移除单个功能。
停止 DeepTutor(在其终端中按 Ctrl+C),然后使用相同的 Python 环境和 DEEPTUTOR_HOME:
deeptutor module list # installed / enabled / ready
deeptutor module disable research # hide and deactivate; keep code
deeptutor module enable research # restore it and required modules
# Package installations only; source checkouts use enable / disable:
deeptutor module install solve # install the matching module and dependencies
deeptutor module uninstall solve --dry-run # inspect the plan and dependency blockers
deeptutor module uninstall solve # remove only this module's distribution
deeptutor chat # restart the CLI; use start for an installed Web app
例如:solve、research、questions、knowledge、parsing、reading、mastery、books、memory、notebook 和 partners。存在依赖方时会阻止移除;核心无法通过模块命令移除。禁用或卸载会保留设置、对话、知识库和生成文件。共享的第三方依赖也会保留。
在浏览器中: 设置 → 运行状态 → 模块显示模块状态及对应的终端命令。软件包变更需要停止环境,并在 CLI 中完成。聊天 → 自定义页面和学习 → 新建学习 → 自定义页面会立即改变个人页面选项;隐藏入口不会卸载其模块,也不会撤销访问权限。
1.7.0 软件包家族的核心与功能 wheel 使用一致的版本。本地 wheel 安装时,为 module install 传入 --wheelhouse /path/to/wheels。构建 wheel 和部署细节见模块安装与源码开发。
🧩 生态系统 — EduHub 与技能社区
DeepTutor 技能使用开放的 Agent-Skills 格式 — 一个包含 SKILL.md 剧本(YAML frontmatter + Markdown)和可选参考文件的文件夹。该格式与 DeepTutor 无关,因此任何支持该格式的注册表都可以成为你的技能库来源。DeepTutor 内置了 EduHub — 我们自己的教育技能注册表 — 作为默认 Hub。
EduHub — DeepTutor 的技能生态
EduHub 是 DeepTutor 为分享教学导向的智能体技能而创建的社区 Hub — 苏格拉底式导师、闪卡生成器、作文反馈、考试蓝图、概念讲解器等。它内置于 DeepTutor,无需任何配置:裸 slug 或 eduhub: 前缀均可解析到它。
查找与安装 — 在浏览器中,打开学习空间 → 技能 → 从 EduHub 导入,浏览目录并将技能直接下载到你的库中。从终端:
deeptutor skill search "socratic tutor" # search EduHub (the default hub)
deeptutor skill install socratic-tutor # fetch → verify → register
deeptutor skill install eduhub:[email protected] # pin a hub and a version
deeptutor skill list # local skills with their hub provenance
发布自己的技能 — 打包一个 SKILL.md 并分享给社区:
deeptutor skill login # browser sign-in to EduHub
deeptutor skill publish ./my-skill # interactive: pick a track + tags, then upload
deeptutor skill update # roll back or release a new version
EduHub 也是一个独立的、ClawHub 兼容的注册表,因此非 DeepTutor 的智能体(Claude Code、Codex 等)可以通过 eduhub CLI 直接使用它 — npx eduhub install socratic-tutor。
导入安全门
无论来源如何,每次导入在触及你的工作区之前都会经过相同的安全门:
- 首先检查注册表的安全验证结果 — 被标记的包将被拒绝,除非你传入
--allow-unverified; - 压缩包会经过路径穿越、条目数量、大小、压缩比、后缀和符号链接检查后进行防御性解压;可执行权限位会被移除,但仍允许无扩展名文件;
- frontmatter 被规范化并去除
always:,因此下载的技能永远无法强制将自己注入每个系统提示; - 来源信息 — Hub、版本、验证结果和安装时间 — 被写入
.hub-lock.json以供审计和更新。
在多用户部署中,浏览器导入会进入经过认证的调用者技能层,而 CLI 和管理控制台安装则以所有者/管理员工作区为目标;在获得授权之前,管理员技能对普通用户保持隐藏且只读。
同样兼容 ClawHub
因为 DeepTutor 支持开放的 Agent-Skills 格式,ClawHub 也是一等来源 — 它与 EduHub 并列内置。使用 Hub 前缀选择:
deeptutor skill search "git release notes" --hub clawhub
deeptutor skill install clawhub:[email protected]
deeptutor skill install clawhub:udiedrichsen/stock-analysis
当多个发布者共用同一个 slug 时,搜索结果会列出每个发布者及其完整限定的安装引用(clawhub:<ownerHandle>/<slug>)。
在 data/user/settings/skill_hubs.json 中添加更多注册表:type: "clawhub" 条目指向任何兼容的 HTTP API(EduHub 和 ClawHub 都支持),type: "command" 包装注册表自带的任何获取 CLI,"default" 选择用于裸 slug 的 Hub。所有这些来源都经过同一个导入安全门。
🤝 开源伙伴
使用优惠码 DEEPTUTOR20 — 首次订阅 PageIndex 立减 $20!
🌐 社区
🔗 维护者
Bingxi Zhao |
Xingyu Hou |
Jiahao Zhang |
📮 联系方式
DeepTutor 是一个由 HKUDS 团队中的 Bingxi Zhao 主导的开源项目,以完全开源的形式持续迭代,与社区共同构建。迄今为止,我们没有任何形式的付费在线产品。欢迎通过 [email protected] 联系我们,探讨想法或合作。
🙏 致谢
衷心感谢香港大学数据智能实验室主任 Chao Huang 的大力支持,以及 HKUDS 实验室同学们的热心相助 — 特别是 Jiahao Zhang、Zirui Guo 和 Xubin Ren。我们也对开源社区深表感激:你们的 Star、Issue、Pull Request 和讨论,每天都在塑造 DeepTutor。
DeepTutor 也站在众多优秀开源项目的肩膀上,它们给予了我们工具和灵感:
| 项目 | 角色 / 启发 |
|---|---|
| LlamaIndex | RAG 流水线和文档索引基础 |
| nanobot | 驱动原版 TutorBot 的超轻量智能体引擎 (HKUDS) |
| LightRAG | 简单快速的 RAG (HKUDS) |
| AutoAgent | 零代码智能体框架 (HKUDS) |
| AI-Researcher | 自动化研究流水线 (HKUDS) |
| OpenClaw | 支撑 ClawHub 的开放智能体网关与技能生态 |
| Codex | 启发我们 CLI 工作流的智能体原生编程 CLI |
| Claude Code | 启发 DeepTutor 智能体循环的智能体编程 CLI |
| ManimCat | Math Animator 的 AI 驱动数学动画生成 |
🗺️ 路线图与贡献
我们希望 DeepTutor 持续迭代与进步 — 并最终成为我们回馈开源社区的礼物。我们的路线图持续更新;欢迎在那里为议题投票或提出新想法。如果你想贡献,请查看贡献指南,了解分支策略、编码规范及参与方式。
基于 Apache License 2.0 许可证。
