deer-flow

环境要求

• git（用于克隆仓库）
• make（README 中的 setup/config/doctor 均为 make 命令）
• Python 环境（项目为 Python 编写，部署需可运行的 Python 运行时）
• 一个 LLM 提供商的 API Key（如 OPENAI_API_KEY、OPENROUTER_API_KEY、VLLM_API_KEY）

安装与启动步骤

1. 1克隆仓库

   把 DeerFlow 仓库拉到本地并进入项目根目录，后续所有 make 命令都在 deer-flow/ 下执行。

   git clone https://github.com/bytedance/deer-flow.git
   cd deer-flow

   复制

2. 2运行配置向导

   在项目根目录执行交互式向导，选择 LLM 提供商、可选的网页搜索、沙箱与文件写入等安全偏好；约 2 分钟。

   make setup

   复制

3. 3高级手动配置

   若不想用向导、希望直接编辑配置，运行该命令复制完整模板 config.yaml，再参考 config.example.yaml 逐项填写。

   make config

   复制

4. 4编辑模型配置

   在 config.yaml 的 models 列表里配置模型，OpenRouter 等兼容网关用 langchain_openai:ChatOpenAI 加 base_url，密钥写 $ 变量名。

5. 5检查配置

   随时运行 doctor 校验本机配置是否正确，并按输出的修复提示处理缺失项。

   make doctor

   复制

6. 6可选安装 MCode

   如需把 MiniMax Code 作为 ACP agent 使用，先全局安装并登录，再在 config.yaml 的 acp_agents 中登记。

   npm install --global @minimax-ai/code
   mcode login

   复制

关键配置

如何确认成功

运行 make doctor，若输出无错误并给出配置校验通过的结果，即表示本机环境与配置就绪。

常见问题

注意事项

• DeerFlow 2.0 为全新重写版本，与 v1 不共享代码，请勿混用 v1 的配置与文档。
• support-bundle 生成物只含脱敏诊断与文件清单，不包含 .env、原始对话消息和用户文件内容。
• 若为模型配置了每模型价格，所有已定价模型必须使用同一币种，混用币种会禁用控制台费用估算。
• 在容器里使用 MCode 时，mcode 必须位于 Gateway 进程的 PATH 中，只装在 Docker 宿主机上不可用。