Commit
Β·
c469a70
1
Parent(s):
865c0b7
update readme
Browse files
README.md
CHANGED
@@ -66,10 +66,29 @@ 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 |
- [π 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,6 +97,7 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
|
|
78 |
- [π₯ Community](#-community)
|
79 |
- [β FAQ](#-faq)
|
80 |
- [π Exploring CAMEL Dependency](#-exploring-camel-dependency)
|
|
|
81 |
- [β Star History](#-star-history)
|
82 |
|
83 |
# π₯ News
|
@@ -270,11 +290,20 @@ cp owl/.env_template owl/.env
|
|
270 |
# Edit the .env file and fill in your API keys
|
271 |
|
272 |
# Option 1: Using docker-compose directly
|
273 |
-
#
|
274 |
-
|
275 |
-
|
276 |
docker-compose up -d
|
277 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
278 |
# Run OWL inside the container
|
279 |
docker-compose exec owl bash
|
280 |
|
@@ -286,7 +315,7 @@ playwright install-deps
|
|
286 |
#run example demo script
|
287 |
xvfb-python examples/run.py
|
288 |
|
289 |
-
# Option
|
290 |
cd .container
|
291 |
chmod +x build_docker.sh
|
292 |
./build_docker.sh
|
|
|
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 |
- [π₯ 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
|
|
|
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 |
|
|
|
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
|