mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-09-14 08:00:10 +00:00
9232e1e6a9
* fix: DeerFlow brand casing in disclaimer, 'What's New' title, setup-sandbox .PHONY - en-US disclaimer said 'Deerflow'; every other user-facing string brands it 'DeerFlow' (rendered under the chat composer) - landing section title 'Whats New in DeerFlow 2.0' -> 'What's New' - setup-sandbox was the only Makefile target missing from .PHONY * test: align disclaimer assertions with DeerFlow brand casing The unit and e2e suites still expected the old "Deerflow" spelling in inputBox.disclaimer; update both to the corrected locale string so the i18n load test and the chat footer assertion pass again. --------- Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
209 lines
8.4 KiB
Makefile
209 lines
8.4 KiB
Makefile
# DeerFlow - Unified Development Environment
|
|
|
|
.PHONY: help config config-upgrade check check-agent-guidance install extension-install extension-list extension-enable extension-disable extension-remove setup doctor support-bundle detect-thread-boundaries detect-blocking-io dev dev-daemon start start-daemon nginx stop up down clean docker-init docker-start docker-stop docker-logs docker-logs-frontend docker-logs-gateway docker-logs-redis setup-sandbox
|
|
|
|
BASH ?= bash
|
|
BACKEND_UV_RUN = cd backend && uv run
|
|
|
|
# Detect OS for Windows compatibility
|
|
ifeq ($(OS),Windows_NT)
|
|
SHELL := cmd.exe
|
|
PYTHON ?= python
|
|
# Run repo shell scripts through Git Bash when Make is launched from cmd.exe / PowerShell.
|
|
RUN_WITH_GIT_BASH = call scripts\run-with-git-bash.cmd
|
|
else
|
|
PYTHON ?= python3
|
|
RUN_WITH_GIT_BASH =
|
|
endif
|
|
|
|
FRONTEND_PNPM = $(PYTHON) ../scripts/pnpm.py
|
|
|
|
help:
|
|
@echo "DeerFlow Development Commands:"
|
|
@echo " make setup - Interactive setup wizard (recommended for new users)"
|
|
@echo " make doctor - Check configuration and system requirements"
|
|
@echo " make support-bundle - Create a redacted issue summary, AI draft, and evidence bundle"
|
|
@echo " make config - Generate local config files (aborts if config already exists)"
|
|
@echo " make config-upgrade - Merge new fields from config.example.yaml into config.yaml"
|
|
@echo " make check - Check if all required tools are installed"
|
|
@echo " make check-agent-guidance - Validate scoped AGENTS.md file and chain budgets"
|
|
@echo " make detect-thread-boundaries - Inventory backend executor/thread/event-loop boundaries"
|
|
@echo " make detect-blocking-io - Inventory blocking IO that may block the backend event loop"
|
|
@echo " make install - Install all dependencies (frontend + backend + pre-commit hooks)"
|
|
@echo " make extension-install SOURCE=... - Install and enable a trusted Python extension"
|
|
@echo " make extension-list - List configured Python extensions"
|
|
@echo " make extension-enable NAME=... - Enable an installed extension"
|
|
@echo " make extension-disable NAME=... - Disable an extension without uninstalling it"
|
|
@echo " make extension-remove NAME=... - Uninstall a managed extension"
|
|
@echo " make setup-sandbox - Pre-pull sandbox container image (recommended)"
|
|
@echo " make dev - Start all services in development mode (with hot-reloading)"
|
|
@echo " make dev-daemon - Start dev services in background (daemon mode)"
|
|
@echo " make start - Start all services in production mode (optimized, no hot-reloading)"
|
|
@echo " make start-daemon - Start prod services in background (daemon mode)"
|
|
@echo " make nginx - Start nginx alone in the foreground (local dev config)"
|
|
@echo " make stop - Stop all running services"
|
|
@echo " make clean - Clean up processes and temporary files"
|
|
@echo ""
|
|
@echo "Docker Production Commands:"
|
|
@echo " make up - Build and start production Docker services (localhost:2026)"
|
|
@echo " make down - Stop and remove production Docker containers"
|
|
@echo ""
|
|
@echo "Docker Development Commands:"
|
|
@echo " make docker-init - Pull the sandbox image"
|
|
@echo " make docker-start - Start Docker services (mode-aware from config.yaml, localhost:2026)"
|
|
@echo " make docker-stop - Stop Docker development services"
|
|
@echo " make docker-logs - View Docker development logs"
|
|
@echo " make docker-logs-frontend - View Docker frontend logs"
|
|
@echo " make docker-logs-gateway - View Docker gateway logs"
|
|
@echo " make docker-logs-redis - View Docker Redis logs"
|
|
|
|
## Setup & Diagnosis
|
|
setup:
|
|
@$(BACKEND_UV_RUN) python ../scripts/setup_wizard.py
|
|
|
|
doctor:
|
|
@$(BACKEND_UV_RUN) python ../scripts/doctor.py
|
|
|
|
support-bundle:
|
|
@$(BACKEND_UV_RUN) python ../scripts/support_bundle.py --include-doctor
|
|
|
|
detect-thread-boundaries:
|
|
@$(BACKEND_UV_RUN) python ../scripts/detect_thread_boundaries.py --json-output ../.deer-flow/thread-boundary-inventory.json
|
|
|
|
detect-blocking-io:
|
|
@$(MAKE) -C backend detect-blocking-io
|
|
|
|
config:
|
|
@$(PYTHON) ./scripts/configure.py
|
|
|
|
config-upgrade:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/config-upgrade.sh
|
|
|
|
# Check required tools
|
|
check:
|
|
@$(PYTHON) ./scripts/check.py
|
|
|
|
check-agent-guidance:
|
|
@$(PYTHON) ./scripts/check_agent_guidance.py
|
|
|
|
# Install all dependencies
|
|
install:
|
|
@echo "Installing backend dependencies..."
|
|
@cd backend && uv sync --locked
|
|
@echo "Installing frontend dependencies..."
|
|
@cd frontend && $(FRONTEND_PNPM) install
|
|
@echo "Installing pre-commit hooks..."
|
|
@uv tool install pre-commit
|
|
@pre-commit install --overwrite
|
|
@echo "✓ All dependencies installed"
|
|
@echo ""
|
|
@echo "=========================================="
|
|
@echo " Optional: Pre-pull Sandbox Image"
|
|
@echo "=========================================="
|
|
@echo ""
|
|
@echo "If you plan to use Docker/Container-based sandbox, you can pre-pull the image:"
|
|
@echo " make setup-sandbox"
|
|
@echo ""
|
|
|
|
extension-install: export DEER_FLOW_EXTENSION_SOURCE := $(value SOURCE)
|
|
extension-install:
|
|
$(if $(and $(filter command line,$(origin SOURCE)),$(strip $(value SOURCE))),,$(error usage: make extension-install SOURCE=<package|git-url|dir>))
|
|
@cd backend && uv run --frozen --no-group extensions deerflow extensions install --source-env __deerflow_extension_source__
|
|
|
|
extension-list:
|
|
@cd backend && uv run --frozen --no-group extensions deerflow extensions list
|
|
|
|
extension-enable: export DEER_FLOW_EXTENSION_NAME := $(value NAME)
|
|
extension-enable:
|
|
$(if $(and $(filter command line,$(origin NAME)),$(strip $(value NAME))),,$(error usage: make extension-enable NAME=<extension>))
|
|
@cd backend && uv run --frozen --no-group extensions deerflow extensions enable --name-env __deerflow_extension_name__
|
|
|
|
extension-disable: export DEER_FLOW_EXTENSION_NAME := $(value NAME)
|
|
extension-disable:
|
|
$(if $(and $(filter command line,$(origin NAME)),$(strip $(value NAME))),,$(error usage: make extension-disable NAME=<extension>))
|
|
@cd backend && uv run --frozen --no-group extensions deerflow extensions disable --name-env __deerflow_extension_name__
|
|
|
|
extension-remove: export DEER_FLOW_EXTENSION_NAME := $(value NAME)
|
|
extension-remove:
|
|
$(if $(and $(filter command line,$(origin NAME)),$(strip $(value NAME))),,$(error usage: make extension-remove NAME=<extension>))
|
|
@cd backend && uv run --frozen --no-group extensions deerflow extensions remove --name-env __deerflow_extension_name__
|
|
|
|
# Pre-pull sandbox Docker image (optional but recommended)
|
|
setup-sandbox:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/setup-sandbox.sh
|
|
|
|
# Start all services in development mode (with hot-reloading)
|
|
dev:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev
|
|
|
|
# Start all services in production mode (with optimizations)
|
|
start:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod
|
|
|
|
# Start all services in daemon mode (background)
|
|
dev-daemon:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --dev --daemon
|
|
|
|
# Start prod services in daemon mode (background)
|
|
start-daemon:
|
|
@$(PYTHON) ./scripts/check.py
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --prod --daemon
|
|
|
|
# Start nginx alone in the foreground with the local dev config
|
|
nginx:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/nginx.sh
|
|
|
|
# Stop all services
|
|
stop:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/serve.sh --stop
|
|
|
|
# Clean up
|
|
clean: stop
|
|
@echo "Cleaning up..."
|
|
@-rm -rf backend/.deer-flow 2>/dev/null || true
|
|
@-rm -rf logs/*.log 2>/dev/null || true
|
|
@echo "✓ Cleanup complete"
|
|
|
|
# ==========================================
|
|
# Docker Development Commands
|
|
# ==========================================
|
|
|
|
# Initialize Docker containers and install dependencies
|
|
docker-init:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh init
|
|
|
|
# Start Docker development environment
|
|
docker-start:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh start
|
|
|
|
# Stop Docker development environment
|
|
docker-stop:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh stop
|
|
|
|
# View Docker development logs
|
|
docker-logs:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs
|
|
|
|
# View Docker development logs
|
|
docker-logs-frontend:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs --frontend
|
|
docker-logs-gateway:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs --gateway
|
|
docker-logs-redis:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/docker.sh logs --redis
|
|
|
|
# ==========================================
|
|
# Production Docker Commands
|
|
# ==========================================
|
|
|
|
# Build and start production services
|
|
up:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/deploy.sh
|
|
|
|
# Stop and remove production containers
|
|
down:
|
|
@$(RUN_WITH_GIT_BASH) ./scripts/deploy.sh down
|