bytedance/deer-flow

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/bytedance/deer-flow.svg?style=card)](https://bestofgithub.dev/repo/bytedance/deer-flow)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/bytedance/deer-flow.svg)](https://bestofgithub.dev/repo/bytedance/deer-flow)

Loading README…

Deployment target	Starting point	Recommended	Notes
Local evaluation / `make dev`	4 vCPU, 8 GB RAM, 20 GB free SSD	8 vCPU, 16 GB RAM	Good for one developer or one light session with hosted model APIs. `2 vCPU / 4 GB` is usually not enough.
Docker development / `make docker-start`	4 vCPU, 8 GB RAM, 25 GB free SSD	8 vCPU, 16 GB RAM	Image builds, bind mounts, and sandbox containers need more headroom than pure local dev.
Long-running server / `make up`	8 vCPU, 16 GB RAM, 40 GB free SSD	16 vCPU, 32 GB RAM	Preferred for shared use, multi-agent runs, report generation, or heavier sandbox workloads.

	Local Foreground	Local Daemon	Docker Dev	Docker Prod
Dev	`./scripts/serve.sh --dev` `make dev`	`./scripts/serve.sh --dev --daemon` `make dev-daemon`	`./scripts/docker.sh start` `make docker-start`	—
Prod	`./scripts/serve.sh --prod` `make start`	`./scripts/serve.sh --prod --daemon` `make start-daemon`	—	`./scripts/deploy.sh` `make up`

Action	Local	Docker Dev	Docker Prod
Stop	`./scripts/serve.sh --stop` `make stop`	`./scripts/docker.sh stop` `make docker-stop`	`./scripts/deploy.sh down` `make down`
Restart	`./scripts/serve.sh --restart [flags]`	`./scripts/docker.sh restart`	—

Channel	Transport	Difficulty
Telegram	Bot API (long-polling)	Easy
Slack	Socket Mode	Moderate
Feishu / Lark	WebSocket	Moderate
WeChat	Tencent iLink (long-polling)	Moderate
WeCom	WebSocket	Moderate
QQ	WebSocket (text-only C2C and group @mentions; four/five passive replies per source)	Moderate
DingTalk	Stream Push (WebSocket)	Moderate
Buzz	Nostr relay (WebSocket, NIP-42)	Moderate

Command	Description
`/new`	Start a new conversation
`/status`	Show current thread info
`/models`	List available models
`/model [name\|default]`	Show or pin the current conversation's model
`/memory`	View memory
`/agent list`	List your Custom Agents
`/agent use <name>`	Start a new conversation with a Custom Agent
`/help`	Show help

🦌 DeerFlow - 2.0

Official Website

Sister Projects

Coding Plan from ByteDance Volcengine

InfoQuest

Table of Contents

One-Line Agent Setup

Quick Start

Configuration

Running the Application

Deployment Sizing

Option 1: Docker (Recommended)

Upgrading an existing checkout

Option 2: Local Development

Startup Modes

LangGraph Studio (Optional)

Docker Production Deployment

Advanced

Sandbox Mode

MCP Server

IM Channels

Request Trace Correlation

LangSmith Tracing

Langfuse Tracing

Monocle Tracing

Using Multiple Providers

Existing-Run Stream Actions

Personal Access Tokens

From Deep Research to Super Agent Harness

Core Features

Workspace

Skills & Tools

Read-only knowledge sources

Exporting Custom Skills

Claude Code Integration

Private Knowledge Retrieval (RAGFlow)

Chat Archive

Session Goals

Manual Context Compaction

Sub-Agents

Sandbox & File System

Agentic Browser Control

Context Engineering

Reading a Referenced Conversation

Current Task Notes

Long-Term Memory

Recommended Models

Embedded Python Client

Projects

Project instructions

Document shelf

Archive read semantics

Trash

Scheduled Tasks

Control proactive IM notifications

Optional group notifications

Lifecycle, safety caps and stop conditions

Create schedules in a conversation

Preview cron occurrences through the API

Upgrade Notes

Terminal Workbench (TUI)

Documentation

⚠️ Security Notice

Improper Deployment May Introduce Security Risks

Gateway Admin Is Equivalent to Code Execution

External Chat Message Roles

Deployment Defaults

Security Recommendations

Contributing

Script workflows (optional extension)

License

Acknowledgments

Key Contributors

Star History