Skip to content

Commit ea74c16

Browse files
committed
udpate readme
1 parent 8e2ee20 commit ea74c16

File tree

2 files changed

+85
-45
lines changed

2 files changed

+85
-45
lines changed

README.md

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -66,29 +66,10 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
6666
- [🎬 Demo Video](#-demo-video)
6767
- [✨️ Core Features](#️-core-features)
6868
- [🛠️ Installation](#️-installation)
69-
- [Option 1: Using uv (Recommended)](#option-1-using-uv-recommended)
70-
- [Option 2: Using venv and pip](#option-2-using-venv-and-pip)
71-
- [Option 3: Using conda](#option-3-using-conda)
72-
- [**Setup Environment Variables**](#setup-environment-variables)
73-
- [Option 1: Using a `.env` File (Recommended)](#option-1-using-a-env-file-recommended)
74-
- [Option 2: Setting Environment Variables Directly](#option-2-setting-environment-variables-directly)
75-
- [**Running with Docker**](#running-with-docker)
7669
- [🚀 Quick Start](#-quick-start)
77-
- [Basic Usage](#basic-usage)
78-
- [Running with Different Models](#running-with-different-models)
79-
- [Model Requirements](#model-requirements)
80-
- [Supported Models](#supported-models)
81-
- [Example Tasks](#example-tasks)
8270
- [🧰 Toolkits and Capabilities](#-toolkits-and-capabilities)
8371
- [Model Context Protocol (MCP)](#model-context-protocol-mcp)
84-
- [Available Toolkits](#available-toolkits)
85-
- [Available Toolkits](#available-toolkits-1)
86-
- [Multimodal Toolkits (Require multimodal model capabilities)](#multimodal-toolkits-require-multimodal-model-capabilities)
87-
- [Text-Based Toolkits](#text-based-toolkits)
88-
- [Customizing Your Configuration](#customizing-your-configuration)
8972
- [🌐 Web Interface](#-web-interface)
90-
- [Starting the Web UI](#starting-the-web-ui)
91-
- [Features](#features)
9273
- [🧪 Experiments](#-experiments)
9374
- [⏱️ Future Plans](#️-future-plans)
9475
- [📄 License](#-license)
@@ -97,7 +78,6 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
9778
- [🔥 Community](#-community)
9879
- [❓ FAQ](#-faq)
9980
- [📚 Exploring CAMEL Dependency](#-exploring-camel-dependency)
100-
- [Accessing CAMEL Source Code](#accessing-camel-source-code)
10181
- [⭐ Star History](#-star-history)
10282

10383
# 🔥 News
@@ -280,6 +260,10 @@ Alternatively, you can set environment variables directly in your terminal:
280260

281261
## **Running with Docker**
282262

263+
OWL can be easily deployed using Docker, which provides a consistent environment across different platforms.
264+
265+
### **Setup Instructions**
266+
283267
```bash
284268
# Clone the repository
285269
git clone https://github.com/camel-ai/owl.git
@@ -288,41 +272,63 @@ cd owl
288272
# Configure environment variables
289273
cp owl/.env_template owl/.env
290274
# Edit the .env file and fill in your API keys
275+
```
276+
277+
### **Deployment Options**
291278

292-
# Option 1: Using docker-compose directly
293-
# Docker image options:
294-
# Option 1: Use pre-built image from Docker Hub (default, faster)
295-
# This option downloads a ready-to-use image and is recommended for most users
279+
#### **Option 1: Using Pre-built Image (Recommended)**
280+
281+
```bash
282+
# This option downloads a ready-to-use image from Docker Hub
283+
# Fastest and recommended for most users
296284
docker-compose up -d
297285

298-
# Option 2: Build image locally (more customizable)
299-
# If you need to customize the Docker image or are unable to access Docker Hub:
286+
# Run OWL inside the container
287+
docker-compose exec owl bash
288+
cd .. && source .venv/bin/activate
289+
playwright install-deps
290+
xvfb-python examples/run.py
291+
```
292+
293+
#### **Option 2: Building Image Locally**
294+
295+
```bash
296+
# For users who need to customize the Docker image or cannot access Docker Hub:
300297
# 1. Open docker-compose.yml
301298
# 2. Comment out the "image: mugglejinx/owl:latest" line
302299
# 3. Uncomment the "build:" section and its nested properties
303300
# 4. Then run:
304301
docker-compose up -d --build
305-
cd .container
306302

307303
# Run OWL inside the container
308304
docker-compose exec owl bash
309-
310-
# activate the virtual environment
311305
cd .. && source .venv/bin/activate
312-
313-
playwright install-deps
314-
315-
#run example demo script
306+
playwright install-deps
316307
xvfb-python examples/run.py
308+
```
317309

318-
# Option 3: Build and run using the provided scripts
310+
#### **Option 3: Using Convenience Scripts**
311+
312+
```bash
313+
# Navigate to container directory
319314
cd .container
315+
316+
# Make the script executable and build the Docker image
320317
chmod +x build_docker.sh
321318
./build_docker.sh
322-
# Run OWL inside the container
319+
320+
# Run OWL with your question
323321
./run_in_docker.sh "your question"
324322
```
325323

324+
### **MCP Desktop Commander Setup**
325+
326+
If using MCP Desktop Commander within Docker, run:
327+
328+
```bash
329+
npx -y @wonderwhy-er/desktop-commander setup --force-file-protocol
330+
```
331+
326332
For more detailed Docker usage instructions, including cross-platform support, optimized configurations, and troubleshooting, please refer to [DOCKER_README.md](.container/DOCKER_README_en.md).
327333

328334
# 🚀 Quick Start

README_zh.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,9 @@ OWL 需要各种 API 密钥来与不同的服务进行交互。`owl/.env_templat
253253
254254
## **使用Docker运行**
255255

256-
如果您希望使用Docker运行OWL项目,我们提供了完整的Docker支持:
256+
OWL可以通过Docker轻松部署,Docker提供了跨不同平台的一致环境。
257+
258+
### **设置说明**
257259

258260
```bash
259261
# 克隆仓库
@@ -263,32 +265,64 @@ cd owl
263265
# 配置环境变量
264266
cp owl/.env_template owl/.env
265267
# 编辑.env文件,填入您的API密钥
268+
```
266269

267-
# 选项1:直接使用docker-compose
268-
cd .container
270+
### **部署选项**
271+
272+
#### **选项1:使用预构建镜像(推荐)**
269273

274+
```bash
275+
# 此选项从Docker Hub下载一个即用型镜像
276+
# 最快速且推荐给大多数用户
270277
docker-compose up -d
271278

272279
# 在容器中运行OWL
273280
docker-compose exec owl bash
274-
275-
# 激活虚拟环境
276281
cd .. && source .venv/bin/activate
282+
playwright install-deps
283+
xvfb-python examples/run.py
284+
```
285+
286+
#### **选项2:本地构建镜像**
277287

278-
playwright install-deps
288+
```bash
289+
# 适用于需要自定义Docker镜像或无法访问Docker Hub的用户:
290+
# 1. 打开docker-compose.yml
291+
# 2. 注释掉"image: mugglejinx/owl:latest"行
292+
# 3. 取消注释"build:"部分及其嵌套属性
293+
# 4. 然后运行:
294+
docker-compose up -d --build
279295

280-
#运行例子演示脚本
296+
# 在容器中运行OWL
297+
docker-compose exec owl bash
298+
cd .. && source .venv/bin/activate
299+
playwright install-deps
281300
xvfb-python examples/run.py
301+
```
302+
303+
#### **选项3:使用便捷脚本**
282304

283-
# 选项2:使用提供的脚本构建和运行
305+
```bash
306+
# 导航到容器目录
284307
cd .container
308+
309+
# 使脚本可执行并构建Docker镜像
285310
chmod +x build_docker.sh
286311
./build_docker.sh
287-
# 在容器中运行OWL
312+
313+
# 使用您的问题运行OWL
288314
./run_in_docker.sh "您的问题"
289315
```
290316

291-
更多详细的Docker使用说明,包括跨平台支持、优化配置和故障排除,请参阅 [DOCKER_README.md](.container/DOCKER_README.md)
317+
### **MCP Desktop Commander设置**
318+
319+
如果在Docker中使用MCP Desktop Commander,请运行:
320+
321+
```bash
322+
npx -y @wonderwhy-er/desktop-commander setup --force-file-protocol
323+
```
324+
325+
更多详细的Docker使用说明,包括跨平台支持、优化配置和故障排除,请参阅 [DOCKER_README.md](.container/DOCKER_README_en.md)
292326

293327
# 🚀 快速开始
294328

0 commit comments

Comments
 (0)