DeerFlow 系列教程 附录 | 核心文件索引、官方文档索引与推荐阅读顺序

DeerFlow 系列教程 附录本附录汇集了 DeerFlow 项目的核心文件索引、官方文档索引和推荐阅读顺序三份速查资料方便读者在日常开发和学习中快速定位关键代码与文档。内容按实际项目目录结构整理所有路径均基于 DeerFlow 2.0 版本验证。附录 ADeerFlow 核心文件索引A.1 Agent 核心文件路径说明关联教程backend/packages/harness/deerflow/agents/lead_agent/agent.pyLead Agent 工厂函数创建完整的 Agent 图结构第 7 篇backend/packages/harness/deerflow/agents/lead_agent/prompt.py系统提示词模板约 31KB定义 Lead Agent 的行为规范第 7 篇backend/packages/harness/deerflow/agents/thread_state.pyAgentState类型定义Agent 的完整状态结构第 7 篇A.2 中间件体系文件路径说明关联教程backend/packages/harness/deerflow/agents/middlewares/15 层中间件目录第 8 篇middlewares/memory_middleware.py记忆中间件——长期记忆注入与更新第 8、11 篇middlewares/sandbox_audit_middleware.py沙箱审计中间件——安全策略强制执行第 8、11 篇middlewares/loop_detection_middleware.py循环检测中间件——防止 Agent 无限循环第 8 篇middlewares/llm_error_handling_middleware.pyLLM 错误处理中间件——自动重试与降级第 8 篇middlewares/title_middleware.py标题生成中间件——自动为对话生成标题第 8 篇middlewares/token_usage_middleware.pyToken 用量跟踪中间件第 8、15 篇middlewares/uploads_middleware.py文件上传中间件——处理用户附件第 8 篇middlewares/view_image_middleware.py图像查看中间件——注入图像内容第 8 篇middlewares/todo_middleware.py待办事项中间件——管理任务列表第 8 篇middlewares/clarification_middleware.py追问澄清中间件——处理用户反馈第 8 篇middlewares/dangling_tool_call_middleware.py悬挂工具调用修复中间件第 8 篇middlewares/deferred_tool_filter_middleware.py延迟工具过滤中间件第 8 篇middlewares/subagent_limit_middleware.py子智能体数量限制中间件第 8、10 篇middlewares/thread_data_middleware.py线程数据中间件——管理线程元信息第 8 篇middlewares/tool_error_handling_middleware.py工具错误处理中间件第 8 篇Note上表中的middlewares/前缀代表完整路径backend/packages/harness/deerflow/agents/middlewares/为节省空间而缩写。A.3 工具体系文件路径说明关联教程backend/packages/harness/deerflow/tools/tools.py工具加载管线——从配置到注入 Agent 的完整流程第 12 篇backend/packages/harness/deerflow/tools/builtins/内置工具目录第 12 篇tools/builtins/task_tool.pyTask 工具——委派子智能体执行任务第 10、12 篇tools/builtins/present_file_tool.py文件展示工具——向用户呈现生成的文件第 12 篇tools/builtins/clarification_tool.py追问澄清工具——向用户提问第 12 篇tools/builtins/tool_search.py工具搜索——动态发现和加载工具第 12 篇tools/builtins/view_image_tool.py图像查看工具第 12 篇tools/builtins/invoke_acp_agent_tool.pyACP Agent 调用工具第 12 篇tools/builtins/setup_agent_tool.pyAgent 配置工具第 12 篇Note上表中tools/builtins/前缀代表完整路径backend/packages/harness/deerflow/tools/builtins/。A.4 Skills 技能系统文件路径说明关联教程backend/packages/harness/deerflow/skills/loader.py技能加载器——三级渐进式加载发现 → 摘要 → 完整内容第 9、18 篇backend/packages/harness/deerflow/skills/parser.pySKILL.md 解析器——YAML frontmatter 提取第 9 篇backend/packages/harness/deerflow/skills/manager.py技能管理器——验证、注册、卸载第 9、18 篇backend/packages/harness/deerflow/skills/types.py技能类型定义SkillDefinition第 9 篇backend/packages/harness/deerflow/skills/installer.py技能安装器——从.skill包安装第 9 篇backend/packages/harness/deerflow/skills/validation.py技能校验——安全和格式检查第 9 篇backend/packages/harness/deerflow/skills/security_scanner.py技能安全扫描——恶意内容检测第 9 篇A.5 Sub-Agents 子智能体文件路径说明关联教程backend/packages/harness/deerflow/subagents/executor.py子智能体执行器——核心编排引擎约 25KB第 10 篇backend/packages/harness/deerflow/subagents/registry.py子智能体注册表——BUILTIN_SUBAGENTS第 10 篇backend/packages/harness/deerflow/subagents/config.py子智能体配置——SubagentConfig第 10 篇backend/packages/harness/deerflow/subagents/builtins/general_purpose.py通用子智能体——默认执行器第 10 篇backend/packages/harness/deerflow/subagents/builtins/bash_agent.pyBash 子智能体——命令执行第 10 篇A.6 Sandbox 沙箱系统文件路径说明关联教程backend/packages/harness/deerflow/sandbox/沙箱系统目录第 11 篇sandbox/sandbox.py沙箱抽象基类第 11 篇sandbox/sandbox_provider.py沙箱提供者工厂第 11 篇sandbox/local/local_sandbox.py本地沙箱实现约 13KB第 11 篇sandbox/local/local_sandbox_provider.py本地沙箱提供者第 11 篇sandbox/tools.py沙箱工具集约 53KB——文件操作、代码执行第 11、12 篇sandbox/security.py沙箱安全策略第 11、15 篇sandbox/middleware.py沙箱中间件第 11 篇sandbox/search.py沙箱内搜索第 11 篇Note上表中sandbox/前缀代表完整路径backend/packages/harness/deerflow/sandbox/。A.7 Memory 记忆系统文件路径说明关联教程backend/packages/harness/deerflow/agents/memory/记忆系统目录第 11 篇memory/updater.py记忆更新器——事实提取、冲突消解约 17KB第 11 篇memory/storage.py记忆存储——持久化读写第 11 篇memory/queue.py记忆队列——异步更新管理第 11 篇memory/prompt.py记忆相关提示词模板约 15KB第 11 篇Note上表中memory/前缀代表完整路径backend/packages/harness/deerflow/agents/memory/。A.8 MCP 集成文件路径说明关联教程backend/packages/harness/deerflow/mcp/MCP 集成目录第 12、18 篇mcp/client.pyMCP 客户端——MultiServerMCPClient 封装第 12、18 篇mcp/tools.pyMCP 工具适配——转换为 LangChain Tool第 12 篇mcp/cache.pyMCP 缓存——带过期检测的惰性缓存第 18 篇mcp/oauth.pyMCP OAuth——GitHub OAuth 认证支持第 18 篇Note上表中mcp/前缀代表完整路径backend/packages/harness/deerflow/mcp/。A.9 模型与配置文件路径说明关联教程backend/packages/harness/deerflow/models/factory.py模型工厂——根据配置创建 LLM 实例第 13 篇backend/packages/harness/deerflow/config/app_config.py主配置加载——解析 config.yaml约 16KB第 5、18 篇backend/packages/harness/deerflow/config/extensions_config.py扩展配置——MCP 服务器配置约 11KB第 12、18 篇backend/packages/harness/deerflow/config/sandbox_config.py沙箱配置——模式选择和参数第 11 篇backend/packages/harness/deerflow/config/memory_config.py记忆配置第 11 篇backend/packages/harness/deerflow/config/model_config.py模型配置——Provider 和模型定义第 13 篇backend/packages/harness/deerflow/config/guardrails_config.py安全防护配置第 15 篇backend/packages/harness/deerflow/config/tracing_config.py追踪配置——LangSmith / Langfuse第 15、18 篇backend/packages/harness/deerflow/config/subagents_config.py子智能体配置第 10 篇backend/packages/harness/deerflow/config/summarization_config.py消息摘要配置第 7 篇backend/packages/harness/deerflow/config/checkpointer_config.pyCheckpointer 配置memory / sqlite / postgres第 5 篇backend/packages/harness/deerflow/config/paths.py路径管理——DEER_FLOW_HOME 等约 12KB第 5、19 篇A.10 客户端与 API 网关文件路径说明关联教程backend/packages/harness/deerflow/client.py嵌入式客户端——程序化调用 DeerFlow约 36KB第 18 篇backend/app/gateway/app.pyFastAPI 网关入口——路由注册和中间件配置第 2 篇backend/app/gateway/routers/threads.py线程 API 路由约 27KB第 2 篇backend/app/gateway/routers/agents.py智能体管理 API第 2 篇backend/app/gateway/routers/skills.py技能管理 API约 15KB第 9 篇backend/app/gateway/routers/memory.py记忆 API约 12KB第 11 篇backend/app/gateway/routers/models.py模型列表 API第 13 篇backend/app/gateway/routers/mcp.pyMCP 管理 API第 12 篇backend/app/gateway/routers/uploads.py文件上传 API第 2 篇backend/app/gateway/routers/artifacts.py制品管理 API第 2 篇backend/app/gateway/routers/runs.pyRun 管理 API第 2 篇backend/app/gateway/routers/suggestions.py建议 API第 2 篇backend/app/gateway/routers/channels.py渠道 API第 14 篇backend/app/gateway/services.py网关服务层——业务逻辑封装约 14KB第 2 篇A.11 IM 渠道集成文件路径说明关联教程backend/app/channels/IM 渠道集成目录第 14 篇backend/app/channels/manager.py渠道管理器——消息分发和生命周期约 36KB第 14 篇backend/app/channels/base.py渠道抽象基类第 14 篇backend/app/channels/feishu.py飞书渠道适配器约 32KB第 14 篇backend/app/channels/wecom.py企业微信渠道适配器约 15KB第 14 篇backend/app/channels/telegram.pyTelegram 渠道适配器约 13KB第 14 篇backend/app/channels/slack.pySlack 渠道适配器第 14 篇backend/app/channels/message_bus.py消息总线——内部消息传递第 14 篇backend/app/channels/store.py渠道存储——会话映射第 14 篇backend/app/channels/service.py渠道服务——公共业务逻辑第 14 篇A.12 前端核心文件路径说明关联教程frontend/src/core/threads/hooks.ts前端核心交互——useThreadStream、useThreads、useDeleteThread第 20 篇frontend/src/core/api/api-client.tsLangGraph API 客户端封装第 20 篇frontend/src/core/api/stream-mode.ts流式模式过滤第 20 篇frontend/src/core/messages/utils.ts消息分组与内容提取约 10KB第 20 篇frontend/src/core/artifacts/loader.ts制品加载器第 20 篇frontend/src/core/i18n/国际化系统11 个文件第 20 篇frontend/src/core/settings/store.ts用户设置状态管理第 20 篇frontend/src/core/config/index.ts前端环境配置Base URL 计算第 20 篇frontend/src/env.js环境变量定义t3-oss/env-nextjs zod第 20 篇frontend/src/app/layout.tsx根布局——ThemeProvider I18nProvider第 20 篇frontend/src/app/page.tsx着陆页入口第 20 篇frontend/src/app/workspace/chats/[thread_id]/page.tsx聊天页面——核心交互页第 20 篇A.13 部署与配置文件路径说明关联教程config.example.yaml主配置模板——模型、工具、沙箱、技能等完整配置第 5、18、19 篇extensions_config.example.jsonMCP 服务器配置模板第 12、18 篇.env.example环境变量模板——API Keys第 5、19 篇frontend/.env.example前端环境变量模板第 19、20 篇docker/docker-compose.yamlDocker 生产编排——Nginx Frontend Gateway LangGraph Provisioner第 19 篇docker/docker-compose-dev.yamlDocker 开发编排——热重载 命名卷第 19 篇docker/nginx/nginx.confNginx 路由配置——反向代理 CORS SSE第 19 篇backend/Dockerfile后端 Dockerfile——多阶段构建builder → dev → runtime第 19 篇frontend/Dockerfile前端 Dockerfile——多阶段构建base → dev / builder → prod第 19 篇Makefile项目构建脚本——config / dev / up / down 等命令第 4、19 篇scripts/deploy.sh生产部署脚本——配置播种 密钥生成 Docker 启动第 19 篇scripts/docker.sh开发 Docker 管理脚本第 19 篇附录 BDeerFlow 官方文档索引B.1 项目级文档文档路径说明主 READMEREADME.md项目总览、快速开始、功能介绍37KB中文 READMEREADME_zh.md中文版项目文档27KB日文 READMEREADME_ja.md日文版项目文档法文 READMEREADME_fr.md法文版项目文档俄文 READMEREADME_ru.md俄文版项目文档安装指南Install.md详细安装步骤贡献指南CONTRIBUTING.md开发贡献规范安全策略SECURITY.md安全漏洞报告流程B.2 后端技术文档文档路径说明架构文档backend/docs/ARCHITECTURE.md深度架构文档——完整的系统设计说明30KB配置文档backend/docs/CONFIGURATION.md配置指南——所有配置项详解13KBAPI 参考backend/docs/API.mdREST API 文档——所有接口说明12KB文件上传backend/docs/FILE_UPLOAD.md文件上传机制说明防护栏backend/docs/GUARDRAILS.md安全策略详解18KB中间件流程backend/docs/middleware-execution-flow.md中间件执行流程可视化10KB摘要策略backend/docs/summarization.md消息摘要策略说明10KB计划模式backend/docs/plan_mode_usage.md计划模式使用指南MCP 服务器backend/docs/MCP_SERVER.mdMCP 集成文档路径示例backend/docs/PATH_EXAMPLES.md文件路径映射说明Harness/App 拆分backend/docs/HARNESS_APP_SPLIT.md后端架构拆分说明13KB环境搭建backend/docs/SETUP.md后端开发环境搭建后端 READMEbackend/README.md后端概览16KB后端贡献指南backend/CONTRIBUTING.md后端开发贡献规范B.3 设计文档RFC文档路径说明创建 Agent RFCbackend/docs/rfc-create-deerflow-agent.md智能体创建设计提案18KB共享模块提取 RFCbackend/docs/rfc-extract-shared-modules.md模块提取设计提案Grep/Glob 工具 RFCbackend/docs/rfc-grep-glob-tools.md搜索工具设计提案13KBB.4 功能实现文档文档路径说明自动标题生成backend/docs/AUTO_TITLE_GENERATION.md标题生成实现说明标题生成实现backend/docs/TITLE_GENERATION_IMPLEMENTATION.md标题生成技术细节记忆改进backend/docs/MEMORY_IMPROVEMENTS.md记忆系统优化记录记忆改进总结backend/docs/MEMORY_IMPROVEMENTS_SUMMARY.md记忆优化总结记忆设置评审backend/docs/MEMORY_SETTINGS_REVIEW.md记忆配置评审Task 工具改进backend/docs/task_tool_improvements.mdTask 工具优化记录Apple Containerbackend/docs/APPLE_CONTAINER.mdApple Container 支持待办事项backend/docs/TODO.md开发待办清单B.5 前端与部署文档文档路径说明前端 READMEfrontend/README.md前端开发指南前端开发指南frontend/CLAUDE.md前端架构和编码规范4KB前端 Agent 指南frontend/AGENTS.md前端 AI 辅助开发指南6KBProvisioner 文档docker/provisioner/README.mdKubernetes Provisioner 使用指南11KBB.6 Skill 文档DeerFlow 内置了丰富的公共技能每个技能的SKILL.md是其能力描述文档技能路径说明PPT 生成skills/public/ppt-generation/SKILL.mdPPT 幻灯片生成27KB深度研究skills/public/deep-research/SKILL.md深度研究报告数据分析skills/public/data-analysis/SKILL.md数据分析报告图表可视化skills/public/chart-visualization/SKILL.md数据图表生成学术论文评审skills/public/academic-paper-review/SKILL.md论文评审分析代码文档skills/public/code-documentation/SKILL.md代码文档生成14KB咨询分析skills/public/consulting-analysis/SKILL.md咨询分析报告33KB图像生成skills/public/image-generation/SKILL.mdAI 图像生成前端设计skills/public/frontend-design/SKILL.md前端 UI 设计Podcast 生成skills/public/podcast-generation/SKILL.md播客脚本生成Newsletter 生成skills/public/newsletter-generation/SKILL.md新闻通讯生成13KBGitHub 深度研究skills/public/github-deep-research/SKILL.mdGitHub 项目分析技能创建器skills/public/skill-creator/SKILL.md辅助创建新技能Agent 引导skills/public/bootstrap/SKILL.mdAgent 引导配置Claude 迁移skills/public/claude-to-deerflow/SKILL.mdClaude 迁移工具技能搜索skills/public/find-skills/SKILL.md技能发现附录 C推荐阅读顺序C.1 系列教程目录编号标题所属模块第 01 篇DeerFlow 是什么——开源 Super Agent 框架全景概览模块一初识 DeerFlow第 02 篇DeerFlow 架构全解——从请求到响应的完整链路模块一初识 DeerFlow第 03 篇DeerFlow 核心概念图谱——理解五大支柱模块一初识 DeerFlow第 04 篇手把手安装 DeerFlow——从零开始搭建你的 AI Agent 平台模块二快速上手第 05 篇配置指南——让 DeerFlow 连接你的大模型模块二快速上手第 06 篇DeerFlow 初体验——从对话到交付的完整工作流模块二快速上手第 07 篇Lead Agent 深度解析——DeerFlow 的决策大脑模块三核心概念深度解析第 08 篇中间件体系——Agent 的生命周期管理模块三核心概念深度解析第 09 篇Skills 技能系统——Agent 的知识与能力扩展模块三核心概念深度解析第 10 篇Sub-Agents 子智能体——并行任务编排的艺术模块三核心概念深度解析第 11 篇Sandbox 沙箱与 Memory 记忆——安全执行与持久认知模块三核心概念深度解析第 12 篇Tools 工具体系——从内置工具到 MCP 扩展模块四高级功能与扩展第 13 篇大模型适配——多 Provider 支持与思考模式模块四高级功能与扩展第 14 篇IM 渠道集成——让 DeerFlow 接入飞书、企微、Slack、Telegram模块四高级功能与扩展第 15 篇Guardrails 安全防护与可观测性模块四高级功能与扩展第 16 篇实战案例一——用 DeerFlow 进行深度研究模块五实战应用场景第 17 篇实战案例二——用 DeerFlow 生成数据可视化与分析报告模块五实战应用场景第 18 篇实战案例三——用 DeerFlow 构建自定义 AI 工作流模块五实战应用场景第 19 篇Docker 生产部署全指南模块六部署与运维第 20 篇前端定制与二次开发指南模块六部署与运维C.2 初学者路径适合刚接触 DeerFlow 的读者快速了解项目并动手使用。第 01 篇项目总览 │ ▼ 第 04 篇安装 DeerFlow │ ▼ 第 05 篇配置大模型 │ ▼ 第 06 篇初体验 │ ▼ 第 03 篇核心概念图谱 │ ▼ 第 16 篇深度研究实战阅读时长约 2-3 小时学习目标理解 DeerFlow 是什么、能做什么完成本地安装和配置体验完整的对话工作流建立对核心概念的整体认知通过实战案例巩固理解C.3 开发者路径适合希望深入理解 DeerFlow 内部机制、进行二次开发或贡献代码的开发者。第 01 篇项目总览 │ ▼ 第 02 篇架构全解 │ ▼ 第 03 篇核心概念 │ ▼ 第 04 篇安装搭建→ 第 05 篇配置指南 │ ▼ 第 07 篇Lead Agent │ ▼ 第 08 篇中间件体系 │ ▼ 第 09 篇Skills 技能 │ ▼ 第 10 篇Sub-Agents │ ▼ 第 11 篇Sandbox Memory │ ▼ 第 12 篇Tools 工具 │ ▼ 第 18 篇自定义工作流实战 │ ▼ 第 20 篇前端定制与二次开发阅读时长约 8-12 小时学习目标掌握从请求到响应的完整链路理解 Agent 核心Lead Agent 中间件 状态管理深入理解五大支柱Skills、Sub-Agents、Sandbox、Memory、Tools能够开发自定义技能和 MCP 集成能够进行前端定制和二次开发C.4 运维路径适合负责 DeerFlow 部署、监控和运维的工程师。第 01 篇项目总览 │ ▼ 第 04 篇安装搭建 │ ▼ 第 05 篇配置指南 │ ▼ 第 15 篇安全防护与可观测性 │ ▼ 第 19 篇Docker 生产部署阅读时长约 3-4 小时学习目标理解项目整体架构掌握安装和配置流程配置安全防护和监控追踪完成 Docker 生产部署建立日常运维能力C.5 全面学习路径适合希望全面掌握 DeerFlow 的读者按顺序阅读全部 20 篇教程。模块一初识 DeerFlow 第 01 篇 → 第 02 篇 → 第 03 篇 模块二快速上手 第 04 篇 → 第 05 篇 → 第 06 篇 模块三核心概念深度解析 第 07 篇 → 第 08 篇 → 第 09 篇 → 第 10 篇 → 第 11 篇 模块四高级功能与扩展 第 12 篇 → 第 13 篇 → 第 14 篇 → 第 15 篇 模块五实战应用场景 第 16 篇 → 第 17 篇 → 第 18 篇 模块六部署与运维 第 19 篇 → 第 20 篇阅读时长约 15-20 小时学习目标从入门到精通的完整学习路径覆盖所有核心概念和高级功能通过三个实战案例巩固理解具备独立部署和二次开发的能力C.6 按需查阅索引如果你有特定的学习需求可以直接跳转到对应的教程学习需求推荐教程前置阅读了解项目全貌第 01 篇无理解系统架构第 02 篇第 01 篇安装部署第 04 篇 第 05 篇第 01 篇开发自定义技能第 09 篇 第 18 篇第 01、07 篇集成 MCP 服务器第 12 篇 第 18 篇第 01、05 篇理解子智能体编排第 10 篇第 07、08 篇配置沙箱执行第 11 篇第 01、05 篇接入大模型第 05 篇 第 13 篇第 01、04 篇接入 IM 渠道第 14 篇第 01、05 篇安全加固与监控第 15 篇第 01、05 篇Docker 生产部署第 19 篇第 01、04、05 篇前端二次开发第 20 篇第 01、02 篇深度研究实战第 16 篇第 06 篇数据可视化实战第 17 篇第 06、09 篇自定义工作流实战第 18 篇第 09、10、12 篇小结本附录提供了三份实用的速查资料附录 A核心文件索引按功能分类列出了 100 个关键源码文件包含文件路径、简要说明和关联教程编号方便在阅读教程时快速定位源码附录 B官方文档索引整理了项目级文档、后端技术文档、RFC 设计文档、功能实现文档、前端文档和 16 个内置技能文档的完整索引附录 C推荐阅读顺序针对初学者、开发者、运维、全面学习四种角色提供了定制化的阅读路径并附上了按需查阅索引表建议将本附录收藏为日常开发和学习的参考手册配合具体教程使用效果更佳。至此DeerFlow 系列教程全部 20 篇正文 附录已完成。感谢阅读