From 0d7c0826f0226ccdec16c26ca78c2dcaa237c150 Mon Sep 17 00:00:00 2001 From: Zhiyunyao Date: Thu, 19 Feb 2026 09:04:37 +0800 Subject: [PATCH] chore: add a Makefile command to create all required local configuration files (#883) * fix: polish the makefile to provide config command for local config setup * docs: polish the instructions in README --- Makefile | 8 +++++++- README.md | 16 +++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 26028dd..0957e30 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ # DeerFlow - Unified Development Environment -.PHONY: help check install dev stop clean docker-init docker-start docker-stop docker-logs docker-logs-frontend docker-logs-gateway +.PHONY: help config check install dev stop clean docker-init docker-start docker-stop docker-logs docker-logs-frontend docker-logs-gateway help: @echo "DeerFlow Development Commands:" @@ -19,6 +19,12 @@ help: @echo " make docker-logs-frontend - View Docker frontend logs" @echo " make docker-logs-gateway - View Docker gateway logs" +config: + @test -f config.yaml || cp config.example.yaml config.yaml + @test -f .env || cp .env.example .env + @test -f frontend/.env || cp frontend/.env.example frontend/.env + @test -f extensions_config.json || cp extensions_config.example.json extensions_config.json + # Check required tools check: @echo "==========================================" diff --git a/README.md b/README.md index e78e443..7cf5235 100644 --- a/README.md +++ b/README.md @@ -37,17 +37,23 @@ Learn more and see **real demos** on our official website. ### Configuration -1. Clone the git repo of DeerFlow +1. Clone the git repo of DeerFlow: ```bash git clone https://github.com/bytedance/deer-flow.git && cd deer-flow ``` -3. **Copy the example config**: +2. Create local config files by copying the example files: ```bash - cp config.example.yaml config.yaml - cp .env.example .env + make config ``` -4. **Edit `config.yaml`** and set your API keys in `.env` and preferred sandbox mode. +3. Update the configs: + +- **Required** + - `config.yaml`: configure your preferred models. + - `.env`: configure your API keys. +- **Optional** + - `frontend/.env`: configure backend API URLs. + - `extensions_config.json`: configure desired MCP servers and skills. #### Sandbox Configuration