From 31e865d88ed012721a72108678a26cd20afb9d46 Mon Sep 17 00:00:00 2001 From: Xiaotian Jin Date: Fri, 14 Mar 2025 17:20:23 +0300 Subject: [PATCH] update Readme: add pre-built option in running with docker --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index db2e5d0..ddf6021 100644 --- a/README.md +++ b/README.md @@ -64,16 +64,32 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas - [๐Ÿ“‹ Table of Contents](#-table-of-contents) - [๐Ÿ”ฅ News](#-news) - [๐ŸŽฌ Demo Video](#-demo-video) -- [โœจ๏ธ Core Features](#-core-features) +- [โœจ๏ธ Core Features](#๏ธ-core-features) - [๐Ÿ› ๏ธ Installation](#๏ธ-installation) - - [**Clone the Github repository**](#clone-the-github-repository) - - [**Set up Environment**](#set-up-environment) - - [**Install Dependencies**](#install-dependencies) + - [Option 1: Using uv (Recommended)](#option-1-using-uv-recommended) + - [Option 2: Using venv and pip](#option-2-using-venv-and-pip) + - [Option 3: Using conda](#option-3-using-conda) - [**Setup Environment Variables**](#setup-environment-variables) + - [Option 1: Using a `.env` File (Recommended)](#option-1-using-a-env-file-recommended) + - [Option 2: Setting Environment Variables Directly](#option-2-setting-environment-variables-directly) - [**Running with Docker**](#running-with-docker) - [๐Ÿš€ Quick Start](#-quick-start) + - [Try MCP (Model Context Protocol) Integration](#try-mcp-model-context-protocol-integration) + - [Basic Usage](#basic-usage) + - [Running with Different Models](#running-with-different-models) + - [Model Requirements](#model-requirements) + - [Supported Models](#supported-models) + - [Example Tasks](#example-tasks) - [๐Ÿงฐ Toolkits and Capabilities](#-toolkits-and-capabilities) + - [Model Context Protocol (MCP)](#model-context-protocol-mcp) + - [Available Toolkits](#available-toolkits) + - [Available Toolkits](#available-toolkits-1) + - [Multimodal Toolkits (Require multimodal model capabilities)](#multimodal-toolkits-require-multimodal-model-capabilities) + - [Text-Based Toolkits](#text-based-toolkits) + - [Customizing Your Configuration](#customizing-your-configuration) - [๐ŸŒ Web Interface](#-web-interface) + - [Starting the Web UI](#starting-the-web-ui) + - [Features](#features) - [๐Ÿงช Experiments](#-experiments) - [โฑ๏ธ Future Plans](#๏ธ-future-plans) - [๐Ÿ“„ License](#-license) @@ -82,6 +98,7 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas - [๐Ÿ”ฅ Community](#-community) - [โ“ FAQ](#-faq) - [๐Ÿ“š Exploring CAMEL Dependency](#-exploring-camel-dependency) + - [Accessing CAMEL Source Code](#accessing-camel-source-code) - [โญ Star History](#-star-history) @@ -261,8 +278,10 @@ cd owl cp owl/.env_template owl/.env # Edit the .env file and fill in your API keys +# Option 1: Using pre-built docker image +docker run -it --rm --env-file owl/.env mugglejinx/owl -# Option 1: Using docker-compose directly +# Option 2: Using docker-compose directly cd .container docker-compose up -d @@ -278,7 +297,7 @@ playwright install-deps #run example demo script xvfb-python examples/run.py -# Option 2: Build and run using the provided scripts +# Option 3: Build and run using the provided scripts cd .container chmod +x build_docker.sh ./build_docker.sh