diff --git a/README.md b/README.md index 2321626..0efb159 100644 --- a/README.md +++ b/README.md @@ -1,160 +1,169 @@ -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}}, -} -``` +
+ +
+๐ŸŒ Other Languages + +- English +- [ไธญๆ–‡](README_zh.md) +- [ํ•œ๊ตญ์–ด](README_ko.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_ko.md b/README_ko.md new file mode 100644 index 0000000..16c85bf --- /dev/null +++ b/README_ko.md @@ -0,0 +1,169 @@ +
+ +
+๐ŸŒ Other Languages + +- [English](README.md) +- [ไธญๆ–‡](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๋Š” ๋†€๋ผ์šด ๋„๊ตฌ์ง€๋งŒ, OpenManus๋Š” *์ดˆ๋Œ€ ์ฝ”๋“œ* ์—†์ด๋„ ๋ชจ๋“  ์•„์ด๋””์–ด๋ฅผ ์‹คํ˜„ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค! ๐Ÿ›ซ + +์šฐ๋ฆฌ ํŒ€์˜ ๋ฉค๋ฒ„์ธ [@Xinbin Liang](https://github.com/mannaandpoem)์™€ [@Jinyu Xiang](https://github.com/XiangJinyu) (ํ•ต์‹ฌ ์ž‘์„ฑ์ž), ๊ทธ๋ฆฌ๊ณ  [@Zhaoyang Yu](https://github.com/MoshiQAQ), [@Jiayi Zhang](https://github.com/didiforgithub), [@Sirui Hong](https://github.com/stellaHSR)์ด ํ•จ๊ป˜ ํ–ˆ์Šต๋‹ˆ๋‹ค. ์šฐ๋ฆฌ๋Š” [@MetaGPT](https://github.com/geekan/MetaGPT)๋กœ๋ถ€ํ„ฐ ์™”์Šต๋‹ˆ๋‹ค. ํ”„๋กœํ† ํƒ€์ž…์€ ๋‹จ 3์‹œ๊ฐ„ ๋งŒ์— ์ถœ์‹œ๋˜์—ˆ์œผ๋ฉฐ, ๊ณ„์†ํ•ด์„œ ๋ฐœ์ „ํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค! + +์ด ํ”„๋กœ์ ํŠธ๋Š” ๊ฐ„๋‹จํ•œ ๊ตฌํ˜„์—์„œ ์‹œ์ž‘๋˜์—ˆ์œผ๋ฉฐ, ์—ฌ๋Ÿฌ๋ถ„์˜ ์ œ์•ˆ, ๊ธฐ์—ฌ ๋ฐ ํ”ผ๋“œ๋ฐฑ์„ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค! + +OpenManus๋ฅผ ํ†ตํ•ด ์—ฌ๋Ÿฌ๋ถ„๋งŒ์˜ ์—์ด์ „ํŠธ๋ฅผ ์ฆ๊ฒจ๋ณด์„ธ์š”! + +๋˜ํ•œ [OpenManus-RL](https://github.com/OpenManus/OpenManus-RL)์„ ์†Œ๊ฐœํ•˜๊ฒŒ ๋˜์–ด ๊ธฐ์ฉ๋‹ˆ๋‹ค. OpenManus์™€ UIUC ์—ฐ๊ตฌ์ž๋“ค์ด ๊ณต๋™ ๊ฐœ๋ฐœํ•œ ์ด ์˜คํ”ˆ์†Œ์Šค ํ”„๋กœ์ ํŠธ๋Š” LLM ์—์ด์ „ํŠธ์— ๋Œ€ํ•ด ๊ฐ•ํ™” ํ•™์Šต(RL) ๊ธฐ๋ฐ˜ (์˜ˆ: GRPO) ํŠœ๋‹ ๋ฐฉ๋ฒ•์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. + +## ํ”„๋กœ์ ํŠธ ๋ฐ๋ชจ + + + +## ์„ค์น˜ ๋ฐฉ๋ฒ• + +๋‘ ๊ฐ€์ง€ ์„ค์น˜ ๋ฐฉ๋ฒ•์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. **๋ฐฉ๋ฒ• 2 (uv ์‚ฌ์šฉ)** ์ด ๋” ๋น ๋ฅธ ์„ค์น˜์™€ ํšจ์œจ์ ์ธ ์ข…์†์„ฑ ๊ด€๋ฆฌ๋ฅผ ์œ„ํ•ด ๊ถŒ์žฅ๋ฉ๋‹ˆ๋‹ค. + +### ๋ฐฉ๋ฒ• 1: conda ์‚ฌ์šฉ + +1. ์ƒˆ๋กœ์šด conda ํ™˜๊ฒฝ์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค: + +```bash +conda create -n open_manus python=3.12 +conda activate open_manus +``` + +2. ์ €์žฅ์†Œ๋ฅผ ํด๋ก ํ•ฉ๋‹ˆ๋‹ค: + +```bash +git clone https://github.com/mannaandpoem/OpenManus.git +cd OpenManus +``` + +3. ์ข…์†์„ฑ์„ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค: + +```bash +pip install -r requirements.txt +``` + +### ๋ฐฉ๋ฒ• 2: uv ์‚ฌ์šฉ (๊ถŒ์žฅ) + +1. uv๋ฅผ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค. (๋น ๋ฅธ Python ํŒจํ‚ค์ง€ ์„ค์น˜ ๋ฐ ์ข…์†์„ฑ ๊ด€๋ฆฌ ๋„๊ตฌ): + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +2. ์ €์žฅ์†Œ๋ฅผ ํด๋ก ํ•ฉ๋‹ˆ๋‹ค: + +```bash +git clone https://github.com/mannaandpoem/OpenManus.git +cd OpenManus +``` + +3. ์ƒˆ๋กœ์šด ๊ฐ€์ƒ ํ™˜๊ฒฝ์„ ์ƒ์„ฑํ•˜๊ณ  ํ™œ์„ฑํ™”ํ•ฉ๋‹ˆ๋‹ค: + +```bash +uv venv +source .venv/bin/activate # Unix/macOS์˜ ๊ฒฝ์šฐ +# Windows์˜ ๊ฒฝ์šฐ: +# .venv\Scripts\activate +``` + +4. ์ข…์†์„ฑ์„ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค: + +```bash +uv pip install -r requirements.txt +``` + +## ์„ค์ • ๋ฐฉ๋ฒ• + +OpenManus๋ฅผ ์‚ฌ์šฉํ•˜๋ ค๋ฉด ์‚ฌ์šฉํ•˜๋Š” LLM API์— ๋Œ€ํ•œ ์„ค์ •์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. ์•„๋ž˜ ๋‹จ๊ณ„๋ฅผ ๋”ฐ๋ผ ์„ค์ •์„ ์™„๋ฃŒํ•˜์„ธ์š”: + +1. `config` ๋””๋ ‰ํ† ๋ฆฌ์— `config.toml` ํŒŒ์ผ์„ ์ƒ์„ฑํ•˜์„ธ์š” (์˜ˆ์ œ ํŒŒ์ผ์„ ๋ณต์‚ฌํ•˜์—ฌ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค): + +```bash +cp config/config.example.toml config/config.toml +``` + +2. `config/config.toml` ํŒŒ์ผ์„ ํŽธ์ง‘ํ•˜์—ฌ API ํ‚ค๋ฅผ ์ถ”๊ฐ€ํ•˜๊ณ  ์„ค์ •์„ ์ปค์Šคํ„ฐ๋งˆ์ด์ง•ํ•˜์„ธ์š”: + +```toml +# ์ „์—ญ LLM ์„ค์ • +[llm] +model = "gpt-4o" +base_url = "https://api.openai.com/v1" +api_key = "sk-..." # ์‹ค์ œ API ํ‚ค๋กœ ๋ณ€๊ฒฝํ•˜์„ธ์š” +max_tokens = 4096 +temperature = 0.0 + +# ํŠน์ • LLM ๋ชจ๋ธ์— ๋Œ€ํ•œ ์„ ํƒ์  ์„ค์ • +[llm.vision] +model = "gpt-4o" +base_url = "https://api.openai.com/v1" +api_key = "sk-..." # ์‹ค์ œ API ํ‚ค๋กœ ๋ณ€๊ฒฝํ•˜์„ธ์š” +``` + +## ๋น ๋ฅธ ์‹œ์ž‘ + +OpenManus๋ฅผ ์‹คํ–‰ํ•˜๋Š” ํ•œ ์ค„ ๋ช…๋ น์–ด: + +```bash +python main.py +``` + +์ดํ›„ ํ„ฐ๋ฏธ๋„์—์„œ ์•„์ด๋””์–ด๋ฅผ ์ž‘์„ฑํ•˜์„ธ์š”! + +unstable ๋ฒ„์ „์„ ์‹คํ–‰ํ•˜๋ ค๋ฉด ์•„๋ž˜ ๋ช…๋ น์–ด๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค: + +```bash +python run_flow.py +``` + +## ๊ธฐ์—ฌ ๋ฐฉ๋ฒ• + +๋ชจ๋“  ์นœ์ ˆํ•œ ์ œ์•ˆ๊ณผ ์œ ์šฉํ•œ ๊ธฐ์—ฌ๋ฅผ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค! ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜๊ฑฐ๋‚˜ ํ’€ ๋ฆฌํ€˜์ŠคํŠธ๋ฅผ ์ œ์ถœํ•ด ์ฃผ์„ธ์š”. + +๋˜๋Š” ๐Ÿ“ง ๋ฉ”์ผ๋กœ ์—ฐ๋ฝ์ฃผ์„ธ์š”. @mannaandpoem : mannaandpoem@gmail.com + +## ์ปค๋ฎค๋‹ˆํ‹ฐ ๊ทธ๋ฃน +Feishu ๋„คํŠธ์›Œํ‚น ๊ทธ๋ฃน์— ์ฐธ์—ฌํ•˜์—ฌ ๋‹ค๋ฅธ ๊ฐœ๋ฐœ์ž๋“ค๊ณผ ๊ฒฝํ—˜์„ ๊ณต์œ ํ•˜์„ธ์š”! + +
+ OpenManus ไบคๆต็พค +
+ +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=mannaandpoem/OpenManus&type=Date)](https://star-history.com/#mannaandpoem/OpenManus&Date) + +## ๊ฐ์‚ฌ์˜ ๊ธ€ + +์ด ํ”„๋กœ์ ํŠธ์— ๊ธฐ๋ณธ์ ์ธ ์ง€์›์„ ์ œ๊ณตํ•ด ์ฃผ์‹  [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 ๊ธฐ์—ฌ์ž๋“ค์— ์˜ํ•ด ๊ฐœ๋ฐœ๋˜์—ˆ์Šต๋‹ˆ๋‹ค. ์ด ์—์ด์ „ํŠธ ์ปค๋ฎค๋‹ˆํ‹ฐ์— ๊นŠ์€ ๊ฐ์‚ฌ๋ฅผ ์ „ํ•ฉ๋‹ˆ๋‹ค! + +## ์ธ์šฉ +```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 43506b0..1ff7828 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,4 +1,13 @@ -[English](README.md) | ไธญๆ–‡ +
+ +
+๐ŸŒ Other Languages + +- [English](README.md) +- ไธญๆ–‡ +- [ํ•œ๊ตญ์–ด](README_ko.md) + +
[![GitHub stars](https://img.shields.io/github/stars/mannaandpoem/OpenManus?style=social)](https://github.com/mannaandpoem/OpenManus/stargazers)