From e1a8cf00de8f268495cd2d2daa0a6ff8202cfd41 Mon Sep 17 00:00:00 2001 From: liangxinbing <1580466765@qq.com> Date: Wed, 12 Mar 2025 00:53:22 +0800 Subject: [PATCH] update README --- README.md | 318 ++++++++++++++++++++++++++------------------------- README_zh.md | 2 + 2 files changed, 162 insertions(+), 158 deletions(-) diff --git a/README.md b/README.md index 8cac223..2321626 100644 --- a/README.md +++ b/README.md @@ -1,158 +1,160 @@ -English | [中文](README_zh.md) - -[![GitHub stars](https://img.shields.io/github/stars/mannaandpoem/OpenManus?style=social)](https://github.com/mannaandpoem/OpenManus/stargazers) -  -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)   -[![Discord Follow](https://dcbadge.vercel.app/api/server/DYn29wFk9z?style=flat)](https://discord.gg/DYn29wFk9z) - -# 👋 OpenManus - -Manus is incredible, but OpenManus can achieve any idea without an *Invite Code* 🛫! - -Our team members [@Xinbin Liang](https://github.com/mannaandpoem) and [@Jinyu Xiang](https://github.com/XiangJinyu) (core authors), along with [@Zhaoyang Yu](https://github.com/MoshiQAQ), [@Jiayi Zhang](https://github.com/didiforgithub), and [@Sirui Hong](https://github.com/stellaHSR), we are from [@MetaGPT](https://github.com/geekan/MetaGPT). The prototype is launched within 3 hours and we are keeping building! - -It's a simple implementation, so we welcome any suggestions, contributions, and feedback! - -Enjoy your own agent with OpenManus! - -We're also excited to introduce [OpenManus-RL](https://github.com/OpenManus/OpenManus-RL), an open-source project dedicated to reinforcement learning (RL)- based (such as GRPO) tuning methods for LLM agents, developed collaboratively by researchers from UIUC and OpenManus. - -## Project Demo - - - -## Installation - -We provide two installation methods. Method 2 (using uv) is recommended for faster installation and better dependency management. - -### Method 1: Using conda - -1. Create a new conda environment: - -```bash -conda create -n open_manus python=3.12 -conda activate open_manus -``` - -2. Clone the repository: - -```bash -git clone https://github.com/mannaandpoem/OpenManus.git -cd OpenManus -``` - -3. Install dependencies: - -```bash -pip install -r requirements.txt -``` - -### Method 2: Using uv (Recommended) - -1. Install uv (A fast Python package installer and resolver): - -```bash -curl -LsSf https://astral.sh/uv/install.sh | sh -``` - -2. Clone the repository: - -```bash -git clone https://github.com/mannaandpoem/OpenManus.git -cd OpenManus -``` - -3. Create a new virtual environment and activate it: - -```bash -uv venv -source .venv/bin/activate # On Unix/macOS -# Or on Windows: -# .venv\Scripts\activate -``` - -4. Install dependencies: - -```bash -uv pip install -r requirements.txt -``` - -## Configuration - -OpenManus requires configuration for the LLM APIs it uses. Follow these steps to set up your configuration: - -1. Create a `config.toml` file in the `config` directory (you can copy from the example): - -```bash -cp config/config.example.toml config/config.toml -``` - -2. Edit `config/config.toml` to add your API keys and customize settings: - -```toml -# Global LLM configuration -[llm] -model = "gpt-4o" -base_url = "https://api.openai.com/v1" -api_key = "sk-..." # Replace with your actual API key -max_tokens = 4096 -temperature = 0.0 - -# Optional configuration for specific LLM models -[llm.vision] -model = "gpt-4o" -base_url = "https://api.openai.com/v1" -api_key = "sk-..." # Replace with your actual API key -``` - -## Quick Start - -One line for run OpenManus: - -```bash -python main.py -``` - -Then input your idea via terminal! - -For unstable version, you also can run: - -```bash -python run_flow.py -``` - -## How to contribute - -We welcome any friendly suggestions and helpful contributions! Just create issues or submit pull requests. - -Or contact @mannaandpoem via 📧email: mannaandpoem@gmail.com - -## Community Group -Join our networking group on Feishu and share your experience with other developers! - -
- OpenManus 交流群 -
- -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=mannaandpoem/OpenManus&type=Date)](https://star-history.com/#mannaandpoem/OpenManus&Date) - -## Acknowledgement - -Thanks to [anthropic-computer-use](https://github.com/anthropics/anthropic-quickstarts/tree/main/computer-use-demo) -and [browser-use](https://github.com/browser-use/browser-use) for providing basic support for this project! - -OpenManus is built by contributors from MetaGPT. Huge thanks to this agent community! - -## Cite -```bibtex -@misc{openmanus2025, - author = {Xinbin Liang and Jinyu Xiang and Zhaoyang Yu and Jiayi Zhang and Sirui Hong}, - title = {OpenManus: An open-source framework for building general AI agents}, - year = {2025}, - publisher = {GitHub}, - journal = {GitHub repository}, - howpublished = {\url{https://github.com/mannaandpoem/OpenManus}}, -} -``` +English | [中文](README_zh.md) + +[![GitHub stars](https://img.shields.io/github/stars/mannaandpoem/OpenManus?style=social)](https://github.com/mannaandpoem/OpenManus/stargazers) +  +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)   +[![Discord Follow](https://dcbadge.vercel.app/api/server/DYn29wFk9z?style=flat)](https://discord.gg/DYn29wFk9z) + +# 👋 OpenManus + +Manus is incredible, but OpenManus can achieve any idea without an *Invite Code* 🛫! + +Our team members [@Xinbin Liang](https://github.com/mannaandpoem) and [@Jinyu Xiang](https://github.com/XiangJinyu) (core authors), along with [@Zhaoyang Yu](https://github.com/MoshiQAQ), [@Jiayi Zhang](https://github.com/didiforgithub), and [@Sirui Hong](https://github.com/stellaHSR), we are from [@MetaGPT](https://github.com/geekan/MetaGPT). The prototype is launched within 3 hours and we are keeping building! + +It's a simple implementation, so we welcome any suggestions, contributions, and feedback! + +Enjoy your own agent with OpenManus! + +We're also excited to introduce [OpenManus-RL](https://github.com/OpenManus/OpenManus-RL), an open-source project dedicated to reinforcement learning (RL)- based (such as GRPO) tuning methods for LLM agents, developed collaboratively by researchers from UIUC and OpenManus. + +## Project Demo + + + +## Installation + +We provide two installation methods. Method 2 (using uv) is recommended for faster installation and better dependency management. + +### Method 1: Using conda + +1. Create a new conda environment: + +```bash +conda create -n open_manus python=3.12 +conda activate open_manus +``` + +2. Clone the repository: + +```bash +git clone https://github.com/mannaandpoem/OpenManus.git +cd OpenManus +``` + +3. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +### Method 2: Using uv (Recommended) + +1. Install uv (A fast Python package installer and resolver): + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +2. Clone the repository: + +```bash +git clone https://github.com/mannaandpoem/OpenManus.git +cd OpenManus +``` + +3. Create a new virtual environment and activate it: + +```bash +uv venv +source .venv/bin/activate # On Unix/macOS +# Or on Windows: +# .venv\Scripts\activate +``` + +4. Install dependencies: + +```bash +uv pip install -r requirements.txt +``` + +## Configuration + +OpenManus requires configuration for the LLM APIs it uses. Follow these steps to set up your configuration: + +1. Create a `config.toml` file in the `config` directory (you can copy from the example): + +```bash +cp config/config.example.toml config/config.toml +``` + +2. Edit `config/config.toml` to add your API keys and customize settings: + +```toml +# Global LLM configuration +[llm] +model = "gpt-4o" +base_url = "https://api.openai.com/v1" +api_key = "sk-..." # Replace with your actual API key +max_tokens = 4096 +temperature = 0.0 + +# Optional configuration for specific LLM models +[llm.vision] +model = "gpt-4o" +base_url = "https://api.openai.com/v1" +api_key = "sk-..." # Replace with your actual API key +``` + +## Quick Start + +One line for run OpenManus: + +```bash +python main.py +``` + +Then input your idea via terminal! + +For unstable version, you also can run: + +```bash +python run_flow.py +``` + +## How to contribute + +We welcome any friendly suggestions and helpful contributions! Just create issues or submit pull requests. + +Or contact @mannaandpoem via 📧email: mannaandpoem@gmail.com + +## Community Group +Join our networking group on Feishu and share your experience with other developers! + +
+ OpenManus 交流群 +
+ +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=mannaandpoem/OpenManus&type=Date)](https://star-history.com/#mannaandpoem/OpenManus&Date) + +## Acknowledgement + +Thanks to [anthropic-computer-use](https://github.com/anthropics/anthropic-quickstarts/tree/main/computer-use-demo) +and [browser-use](https://github.com/browser-use/browser-use) for providing basic support for this project! + +Additionally, we are grateful to [AAAJ](https://github.com/metauto-ai/agent-as-a-judge), [MetaGPT](https://github.com/geekan/MetaGPT) and [OpenHands](https://github.com/All-Hands-AI/OpenHands). + +OpenManus is built by contributors from MetaGPT. Huge thanks to this agent community! + +## Cite +```bibtex +@misc{openmanus2025, + author = {Xinbin Liang and Jinyu Xiang and Zhaoyang Yu and Jiayi Zhang and Sirui Hong}, + title = {OpenManus: An open-source framework for building general AI agents}, + year = {2025}, + publisher = {GitHub}, + journal = {GitHub repository}, + howpublished = {\url{https://github.com/mannaandpoem/OpenManus}}, +} +``` diff --git a/README_zh.md b/README_zh.md index 13bb768..43506b0 100644 --- a/README_zh.md +++ b/README_zh.md @@ -145,4 +145,6 @@ python run_flow.py 特别感谢 [anthropic-computer-use](https://github.com/anthropics/anthropic-quickstarts/tree/main/computer-use-demo) 和 [browser-use](https://github.com/browser-use/browser-use) 为本项目提供的基础支持！ +此外，我们感谢 [AAAJ](https://github.com/metauto-ai/agent-as-a-judge)，[MetaGPT](https://github.com/geekan/MetaGPT) 和 [OpenHands](https://github.com/All-Hands-AI/OpenHands). + OpenManus 由 MetaGPT 社区的贡献者共同构建，感谢这个充满活力的智能体开发者社区！