Wendong-Fan commited on
Commit
06f2e08
·
1 Parent(s): c469a70

udpate readme

Browse files
Files changed (2) hide show
  1. README.md +41 -35
  2. README_zh.md +44 -10
README.md CHANGED
@@ -66,29 +66,10 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
66
  - [🎬 Demo Video](#-demo-video)
67
  - [✨️ Core Features](#️-core-features)
68
  - [🛠️ 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)
76
  - [🚀 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)
82
  - [🧰 Toolkits and Capabilities](#-toolkits-and-capabilities)
83
  - [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)
89
  - [🌐 Web Interface](#-web-interface)
90
- - [Starting the Web UI](#starting-the-web-ui)
91
- - [Features](#features)
92
  - [🧪 Experiments](#-experiments)
93
  - [⏱️ Future Plans](#️-future-plans)
94
  - [📄 License](#-license)
@@ -97,7 +78,6 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
97
  - [🔥 Community](#-community)
98
  - [❓ FAQ](#-faq)
99
  - [📚 Exploring CAMEL Dependency](#-exploring-camel-dependency)
100
- - [Accessing CAMEL Source Code](#accessing-camel-source-code)
101
  - [⭐ Star History](#-star-history)
102
 
103
  # 🔥 News
@@ -280,6 +260,10 @@ Alternatively, you can set environment variables directly in your terminal:
280
 
281
  ## **Running with Docker**
282
 
 
 
 
 
283
  ```bash
284
  # Clone the repository
285
  git clone https://github.com/camel-ai/owl.git
@@ -288,41 +272,63 @@ cd owl
288
  # Configure environment variables
289
  cp owl/.env_template owl/.env
290
  # Edit the .env file and fill in your API keys
 
 
 
291
 
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
 
296
  docker-compose up -d
297
 
298
- # Option 2: Build image locally (more customizable)
299
- # If you need to customize the Docker image or are unable to access Docker Hub:
 
 
 
 
 
 
 
 
 
300
  # 1. Open docker-compose.yml
301
  # 2. Comment out the "image: mugglejinx/owl:latest" line
302
  # 3. Uncomment the "build:" section and its nested properties
303
  # 4. Then run:
304
  docker-compose up -d --build
305
- cd .container
306
 
307
  # Run OWL inside the container
308
  docker-compose exec owl bash
309
-
310
- # activate the virtual environment
311
  cd .. && source .venv/bin/activate
312
-
313
- playwright install-deps
314
-
315
- #run example demo script
316
  xvfb-python examples/run.py
 
317
 
318
- # Option 3: Build and run using the provided scripts
 
 
 
319
  cd .container
 
 
320
  chmod +x build_docker.sh
321
  ./build_docker.sh
322
- # Run OWL inside the container
 
323
  ./run_in_docker.sh "your question"
324
  ```
325
 
 
 
 
 
 
 
 
 
326
  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).
327
 
328
  # 🚀 Quick Start
 
66
  - [🎬 Demo Video](#-demo-video)
67
  - [✨️ Core Features](#️-core-features)
68
  - [🛠️ Installation](#️-installation)
 
 
 
 
 
 
 
69
  - [🚀 Quick Start](#-quick-start)
 
 
 
 
 
70
  - [🧰 Toolkits and Capabilities](#-toolkits-and-capabilities)
71
  - [Model Context Protocol (MCP)](#model-context-protocol-mcp)
 
 
 
 
 
72
  - [🌐 Web Interface](#-web-interface)
 
 
73
  - [🧪 Experiments](#-experiments)
74
  - [⏱️ Future Plans](#️-future-plans)
75
  - [📄 License](#-license)
 
78
  - [🔥 Community](#-community)
79
  - [❓ FAQ](#-faq)
80
  - [📚 Exploring CAMEL Dependency](#-exploring-camel-dependency)
 
81
  - [⭐ Star History](#-star-history)
82
 
83
  # 🔥 News
 
260
 
261
  ## **Running with Docker**
262
 
263
+ OWL can be easily deployed using Docker, which provides a consistent environment across different platforms.
264
+
265
+ ### **Setup Instructions**
266
+
267
  ```bash
268
  # Clone the repository
269
  git clone https://github.com/camel-ai/owl.git
 
272
  # Configure environment variables
273
  cp owl/.env_template owl/.env
274
  # Edit the .env file and fill in your API keys
275
+ ```
276
+
277
+ ### **Deployment Options**
278
 
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
284
  docker-compose up -d
285
 
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:
297
  # 1. Open docker-compose.yml
298
  # 2. Comment out the "image: mugglejinx/owl:latest" line
299
  # 3. Uncomment the "build:" section and its nested properties
300
  # 4. Then run:
301
  docker-compose up -d --build
 
302
 
303
  # Run OWL inside the container
304
  docker-compose exec owl bash
 
 
305
  cd .. && source .venv/bin/activate
306
+ playwright install-deps
 
 
 
307
  xvfb-python examples/run.py
308
+ ```
309
 
310
+ #### **Option 3: Using Convenience Scripts**
311
+
312
+ ```bash
313
+ # Navigate to container directory
314
  cd .container
315
+
316
+ # Make the script executable and build the Docker image
317
  chmod +x build_docker.sh
318
  ./build_docker.sh
319
+
320
+ # Run OWL with your question
321
  ./run_in_docker.sh "your question"
322
  ```
323
 
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
+
332
  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).
333
 
334
  # 🚀 Quick Start
README_zh.md CHANGED
@@ -253,7 +253,9 @@ OWL 需要各种 API 密钥来与不同的服务进行交互。`owl/.env_templat
253
 
254
  ## **使用Docker运行**
255
 
256
- 如果您希望使用Docker运行OWL项目,我们提供了完整的Docker支持:
 
 
257
 
258
  ```bash
259
  # 克隆仓库
@@ -263,32 +265,64 @@ cd owl
263
  # 配置环境变量
264
  cp owl/.env_template owl/.env
265
  # 编辑.env文件,填入您的API密钥
 
266
 
267
- # 选项1:直接使用docker-compose
268
- cd .container
 
269
 
 
 
 
270
  docker-compose up -d
271
 
272
  # 在容器中运行OWL
273
  docker-compose exec owl bash
274
-
275
- # 激活虚拟环境
276
  cd .. && source .venv/bin/activate
 
 
 
 
 
277
 
278
- playwright install-deps
 
 
 
 
 
 
279
 
280
- #运行例子演示脚本
 
 
 
281
  xvfb-python examples/run.py
 
 
 
282
 
283
- # 选项2:使用提供的脚本构建和运行
 
284
  cd .container
 
 
285
  chmod +x build_docker.sh
286
  ./build_docker.sh
287
- # 在容器中运行OWL
 
288
  ./run_in_docker.sh "您的问题"
289
  ```
290
 
291
- 更多详细的Docker使用说明,包括跨平台支持、优化配置和故障排除,请参阅 [DOCKER_README.md](.container/DOCKER_README.md)
 
 
 
 
 
 
 
 
292
 
293
  # 🚀 快速开始
294
 
 
253
 
254
  ## **使用Docker运行**
255
 
256
+ OWL可以通过Docker轻松部署,Docker提供了跨不同平台的一致环境。
257
+
258
+ ### **设置说明**
259
 
260
  ```bash
261
  # 克隆仓库
 
265
  # 配置环境变量
266
  cp owl/.env_template owl/.env
267
  # 编辑.env文件,填入您的API密钥
268
+ ```
269
 
270
+ ### **部署选项**
271
+
272
+ #### **选项1:使用预构建镜像(推荐)**
273
 
274
+ ```bash
275
+ # 此选项从Docker Hub下载一个即用型镜像
276
+ # 最快速且推荐给大多数用户
277
  docker-compose up -d
278
 
279
  # 在容器中运行OWL
280
  docker-compose exec owl bash
 
 
281
  cd .. && source .venv/bin/activate
282
+ playwright install-deps
283
+ xvfb-python examples/run.py
284
+ ```
285
+
286
+ #### **选项2:本地构建镜像**
287
 
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
295
 
296
+ # 在容器中运行OWL
297
+ docker-compose exec owl bash
298
+ cd .. && source .venv/bin/activate
299
+ playwright install-deps
300
  xvfb-python examples/run.py
301
+ ```
302
+
303
+ #### **选项3:使用便捷脚本**
304
 
305
+ ```bash
306
+ # 导航到容器目录
307
  cd .container
308
+
309
+ # 使脚本可执行并构建Docker镜像
310
  chmod +x build_docker.sh
311
  ./build_docker.sh
312
+
313
+ # 使用您的问题运行OWL
314
  ./run_in_docker.sh "您的问题"
315
  ```
316
 
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)
326
 
327
  # 🚀 快速开始
328