← Back to Home

ByteDance open source AI

SuperAgent sandbox

In February 2026, ByteDance's open-source project DeerFlow hit #1 on GitHub Trending with 47,000+ stars. What exactly is this "🦌" SuperAgent framework, and how does it fundamentally differ from a regular AI chatbot? I spent a full day deploying and testing it. Here's my complete pitfall-free guide.

Disclosure: All information sourced from the official GitHub repo (MIT license) and documentation. Check deerflow.tech for the latest.

What Is DeerFlow? The Fundamental Difference from Regular AI Assistants

DeerFlow (Deep Exploration and Efficient Research Flow) is a SuperAgent runtime environment — not a chatbot, but a complete AI workstation:

The fundamental difference: Regular AI assistants chat. DeerFlow executes tasks. Tell it "Research quantum computing trends in 2026 and generate a presentation," and it will search, read, code, create charts — all without human intervention.

Architecture Overview

DeerFlow 2.0 uses LangGraph as the core dispatch layer for its agent system, with dynamic tool loading and sub-agent delegation. Three layers:

Key dependencies: Docker (sandbox), MongoDB (memory store), LangGraph (agent orchestration).

🛠️ Prerequisites

🚀 Deployment Steps (Docker, Recommended)

Step 1: Clone the Repository

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

Step 2: Initialize Configuration

make docker-init   # Pull sandbox image (first run takes a few minutes)

This downloads the Docker sandbox image — patience required on first run.

Step 3: Configure API Keys

DeerFlow supports multiple LLM backends. Edit .env or use interactive config:

make config        # Copy full config template
# Or directly edit .env

Key config entries (.env):

# Main agent model (planning and scheduling)
OPENAI_API_KEY=sk-xxxx
# Or use Anthropic
ANTHROPIC_API_KEY=sk-ant-xxxx

# Sub-agent model (can differ from main)
OPENAI_API_BASE=https://api.openai.com/v1

# Sandbox config (defaults work)
SANDBOX_MODE=docker

Step 4: Start All Services

make docker-start  # Starts DeerFlow + MongoDB + sandbox

After startup, visit http://localhost:8000 for the web UI.

Verify Successful Deployment

curl http://localhost:8000/health
# Should return {"status": "ok"}

💣 Pitfall Log and Common Errors

Error 1: Sandbox Image Pull Timeout

**Error**: Error response from daemon: pull access denied

Cause: Default sandbox image is on Docker Hub — slow or blocked in some regions.

Solution:

# Use mirror
docker pull registry.docker-cn.com/bytedance/deer-sandbox:latest
# Or configure Docker daemon acceleration

Add to /etc/docker/daemon.json:

{
  "registry-mirrors": ["https://docker.mirrors.ustc.edu.cn"]
}

Then restart Docker: sudo systemctl restart docker

Error 2: MongoDB Connection Failure

**Error**: pymongo.errors.ServerSelectionTimeoutError

Cause: MongoDB container not running, or incorrect connection string.

Debug steps:

# Check MongoDB container status
docker ps | grep mongo

# Check MongoDB logs
docker logs deer-flow-mongo-1

# Verify connection string
docker exec -it deer-flow-web-1 env | grep MONGO

Solution: Make sure MongoDB service is healthy in docker-compose.yml. Use service name, not localhost:

MONGO_URI=mongodb://deer-flow-mongo-1:27017/deerflow

Error 3: Invalid API Key or Rate Limit

**Error**: Error: Invalid API key or Rate limit exceeded

**Cause**: Wrong key in .env, or account balance exhausted.

Verify keys:

# Test OpenAI key
curl https://api.openai.com/v1/models \
  -H "Authorization: Bearer $OPENAI_API_KEY"

# Confirm OPENAI_API_BASE in .env (needed for some third parties)
OPENAI_API_BASE=https://api.openai.com/v1

Error 4: Sub-agent Tasks Hang

Symptom: Main agent delegates to sub-agent, but sub-agent shows no response.

Cause: Default sub-agent timeout is 30 seconds — insufficient for complex tasks.

**Solution**: Adjust timeout in config.yaml:

sub_agent:
  timeout_seconds: 120   # Bump from 30s to 120s
  max_retries: 3

🧠 DeerFlow + Claude Code: Developer Workflow Integration

One of DeerFlow 2.0's most practical features: Direct bootstrap from Claude Code, Cursor, or Windsurf with a single sentence.

In Claude Code, just type:

Help me clone DeerFlow if needed, then bootstrap it for local development by following https://raw.githubusercontent.com/bytedance/deer-flow/main/Install.md

Claude Code will automatically:

1. Clone the repo (if not present)

2. Detect Docker environment

3. Generate minimal config.yaml

4. Write your API keys to .env

5. Run make docker-start

No manual docs digging required — ideal for developers who want a quick self-hosted setup.

DeerFlow vs n8n: Which to Choose?

DimensionDeerFlown8n
FocusAI task execution frameworkWorkflow automation platform
Core capabilitySandbox + sub-agents + memoryVisual workflow orchestration
Coding requirementLow (YAML config)Medium (nodes + expressions)
Persistent memoryBuilt-in MongoDBRequires extra config
Best forLong-horizon research / report generationBusiness process automation

Choose DeerFlow if you want "AI that autonomously completes a complex multi-step research task." Choose n8n if you want "CRM + Slack + Google Sheets connected and automated." They complement each other.

Advanced: Connecting Domestic Models (China)

DeerFlow accepts any OpenAI-compatible API. SiliconFlow example:

# .env config
OPENAI_API_BASE=https://api.siliconflow.cn/v1
OPENAI_API_KEY=your-siliconflow-key
MODEL_NAME=Qwen/Qwen2.5-72B-Instruct

Recommended domestic models: Qwen2.5 (Alibaba), GLM-4 (Zhipu), DeepSeek-V3 (DeepSeek).

Summary and Next Steps

DeerFlow 2.0 is one of the most compelling open-source AI Agent frameworks in 2026. Core strengths: sandbox execution safety + sub-agent parallelism + persistent memory — ideal for developers who need AI to autonomously complete complex long-horizon tasks.

For more on multi-agent collaboration, see my [n8n Multi-Agent Orchestration Pitfalls] article. For local AI inference, check [Ollama Local Deployment: 5 Real Pitfalls].

Related Tools:

👉 Join MiniMax Token Plan: AI coding acceleration for businesses

👉 Join Zhipu Coding Plan: GLM-4.6/GLM-5 coding packages, China-stable, pay-per-token unlimited

👉 Join Aliyun AI: Top AI products with exclusive coupons for business innovation

📌 This article was AI-assisted generated and human-reviewed | TechPassive — An AI-driven content testing site focused on real tool reviews

🔗 Recommended Tools

These are carefully selected tools. Using our affiliate links supports us to keep producing quality content:

☁️ DigitalOcean Cloud ⚡ Vultr VPS ⭐ MiniMax Token Plan 🧩 Zhipu Coding Plan 🎁 Zhipu 20M Tokens Gift 🤖 QoderWork CN (Refer & Earn) ☁️ Aliyun AI Products 📚 WordPress Books 🔍 WordPress SEO Books 🌐 Web Hosting Books 🐳 Docker Books 🐧 Linux Books 🐍 Python Books 💰 Affiliate Marketing 💵 Passive Income Books 🖥️ Server Books ☁️ Cloud Computing Books 🚀 DevOps Books
← Back to Home