deer-flow

(β˜… 80,475)

An open-source long-horizon SuperAgent harness that researches, codes, and creates. With the help of sandboxes, memories, tools, skill, subagents and message gateway, it handles different levels of tasks that could take minutes to hours.

  • .dockerignore
  • .env.example
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • AGENTS.md
  • CHANGELOG.md
  • CHANGELOG_zh.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • config.example.yaml
  • CONTRIBUTING.md
  • deer-flow.code-workspace
  • extensions_config.example.json
  • Install.md
  • LICENSE
  • Makefile
  • README.md
  • README_fr.md
  • README_ja.md
  • README_ru.md
  • README_zh.md
  • RELEASING.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/bytedance/deer-flow

Downloads the entire project code from GitHub to your computer.

cd deer-flow

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install --global @minimax-ai/code

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
make docker-init # Pull sandbox image (only once or when image updates)

Compiles the code based on the generated build configuration to produce an executable.

make docker-start # Start services (auto-detects sandbox mode from config.yaml)

Compiles the code based on the generated build configuration to produce an executable.

make docker-logs # View logs

Compiles the code based on the generated build configuration to produce an executable.

- [Option 1: Docker (Recommended)](#option-1-docker-recommended)

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install --global @minimax-ai/code

Installs the package published on the npm registry globally β€” no need to clone the source.

make check # Verifies Node.js 22+, pnpm, uv, nginx

Compiles the code based on the generated build configuration to produce an executable.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
uv run python -m deerflow.skills.review.cli ../skills/public/data-analysis --format text --fail-on error --fail-on-incomplete

Runs the Python script (or module).

uv pip install 'deerflow-harness[tui]' # optional 'textual' dependency

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make setup

Compiles the code based on the generated build configuration to produce an executable.

make docker-init # Pull sandbox image (only once or when image updates)

Compiles the code based on the generated build configuration to produce an executable.

make docker-start # Start services (auto-detects sandbox mode from config.yaml)

Compiles the code based on the generated build configuration to produce an executable.

make docker-logs # View logs

Compiles the code based on the generated build configuration to produce an executable.

make up # Build images and start all production services

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation