Skip to content

Install.md

Latest commit

 

History

History
87 lines (63 loc) · 4.6 KB

Install.md

File metadata and controls

87 lines (63 loc) · 4.6 KB

DeerFlow Install

This file is for coding agents. If the DeerFlow repository is not already cloned and open, clone https://github.com/bytedance/deer-flow.git first, then continue from the repository root.

Goal

Bootstrap a DeerFlow local development workspace on the user's machine with the least risky path available.

Default preference:

  1. Docker development environment
  2. Local development environment

Do not assume API keys or model credentials exist. Set up everything that can be prepared safely, then stop with a concise summary of what the user still needs to provide.

Operating Rules

  • Be idempotent. Re-running this document should not damage an existing setup.
  • Prefer existing repo commands over ad hoc shell commands.
  • Do not use sudo or install system packages without explicit user approval.
  • Do not overwrite existing user config values unless the user asks.
  • If a step fails, stop, explain the blocker, and provide the smallest next action.
  • If multiple setup paths are possible, prefer Docker when Docker is already available.

Success Criteria

Consider the setup successful when all of the following are true:

  • The DeerFlow repository is cloned and the current working directory is the repo root.
  • config.yaml exists.
  • For Docker setup, make docker-init completed successfully and Docker prerequisites are prepared, but services are not assumed to be running yet.
  • For local setup, make check passed or reported no missing prerequisites, and make install completed successfully.
  • The user receives the exact next command to launch DeerFlow.
  • The user also receives any missing model configuration or referenced environment variable names from config.yaml, without inspecting secret-bearing files for actual values.

Steps

  • If the current directory is not the DeerFlow repository root, clone https://github.com/bytedance/deer-flow.git if needed, then change into the repository root.
  • Confirm the current directory is the DeerFlow repository root by checking that Makefile, backend/, frontend/, and config.example.yaml exist.
  • Detect whether config.yaml already exists.
  • If config.yaml does not exist, run make config.
  • Detect whether Docker is available and the daemon is reachable with docker info.
  • If Docker is available:
    • Run make docker-init.
    • Treat this as Docker prerequisite preparation only. Do not claim that app services, compose validation, or image builds have already succeeded.
    • Do not start long-running services unless the user explicitly asks or this setup request clearly includes launch verification.
    • Tell the user the recommended next command is make docker-start.
  • If Docker is not available:
    • Run make check.
    • If make check reports missing system dependencies such as node, pnpm, uv, or nginx, stop and report the missing tools instead of attempting privileged installs.
    • If prerequisites are satisfied, run make install.
    • Tell the user the recommended next command is make dev.
  • Inspect config.yaml only for missing model entries or referenced environment variable placeholders. Do not read .env, frontend/.env, or other secret-bearing files.
  • If no model is configured, tell the user they must add at least one entry under models in config.yaml.
  • If config.yaml references variables such as $OPENAI_API_KEY, tell the user which variable names still need real values, but do not verify them by opening secret-bearing files.
  • If the repository already appears configured, avoid repeating expensive work unless it is necessary to verify the environment.

Verification

Use the lightest verification that matches the chosen setup path.

For Docker setup:

  • Confirm make docker-init completed successfully.
  • Confirm config.yaml exists.
  • State explicitly that Docker services were not started and make docker-start is still the first real launch step.
  • Do not leave background services running unless the user asked for that.

For local setup:

  • Confirm make install completed successfully.
  • Confirm config.yaml exists.
  • Do not leave background services running unless the user asked for that.

Final Response Format

Return a short status report with:

  1. Setup path used: Docker or local
  2. Setup level reached: Docker prerequisites prepared or local dependencies installed
  3. Files created or detected: for example config.yaml
  4. Remaining user action: model config, env var values, auth files, or nothing
  5. Exact next command to start DeerFlow

EXECUTE NOW

Complete the steps above. When finished, stop after the setup boundary and report status instead of continuing into unrelated project work.