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
This commit is contained in:
Zhiyunyao
2026-02-19 09:04:37 +08:00
committed by GitHub
parent ea4e0139af
commit 0d7c0826f0
2 changed files with 18 additions and 6 deletions

View File

@@ -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