Skip to content

Commit 997caa4

Browse files
keepConcentrationkeepConcentration
authored
docs: add Korean README file (FoundationAgents#481)
* Add README_ko.md file Introduced a new `README_ko.md` file to provide Korean documentation. Updated all README files to include a dropdown for choosing between available languages: English, Chinese, and Korean. * Add acknowledgments for additional contributors in README_ko Updated the Korean README to include acknowledgments for AAAJ, MetaGPT, and OpenHands.
1 parent e1a8cf0 commit 997caa4

File tree

3 files changed

+348
-161
lines changed

3 files changed

+348
-161
lines changed

‎README.md

Lines changed: 169 additions & 160 deletions
Original file line numberDiff line numberDiff line change
@@ -1,160 +1,169 @@
1-
English | [中文](README_zh.md)
2-
3-
[![GitHub stars](https://img.shields.io/github/stars/mannaandpoem/OpenManus?style=social)](https://github.com/mannaandpoem/OpenManus/stargazers)
4-
 
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)  
6-
[![Discord Follow](https://dcbadge.vercel.app/api/server/DYn29wFk9z?style=flat)](https://discord.gg/DYn29wFk9z)
7-
8-
# 👋 OpenManus
9-
10-
Manus is incredible, but OpenManus can achieve any idea without an *Invite Code* 🛫!
11-
12-
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!
13-
14-
It's a simple implementation, so we welcome any suggestions, contributions, and feedback!
15-
16-
Enjoy your own agent with OpenManus!
17-
18-
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.
19-
20-
## Project Demo
21-
22-
<video src="https://private-user-images.githubusercontent.com/61239030/420168772-6dcfd0d2-9142-45d9-b74e-d10aa75073c6.mp4?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NDEzMTgwNTksIm5iZiI6MTc0MTMxNzc1OSwicGF0aCI6Ii82MTIzOTAzMC80MjAxNjg3NzItNmRjZmQwZDItOTE0Mi00NWQ5LWI3NGUtZDEwYWE3NTA3M2M2Lm1wND9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAzMDclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMzA3VDAzMjIzOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdiZjFkNjlmYWNjMmEzOTliM2Y3M2VlYjgyNDRlZDJmOWE3NWZhZjE1MzhiZWY4YmQ3NjdkNTYwYTU5ZDA2MzYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.UuHQCgWYkh0OQq9qsUWqGsUbhG3i9jcZDAMeHjLt5T4" data-canonical-src="https://private-user-images.githubusercontent.com/61239030/420168772-6dcfd0d2-9142-45d9-b74e-d10aa75073c6.mp4?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NDEzMTgwNTksIm5iZiI6MTc0MTMxNzc1OSwicGF0aCI6Ii82MTIzOTAzMC80MjAxNjg3NzItNmRjZmQwZDItOTE0Mi00NWQ5LWI3NGUtZDEwYWE3NTA3M2M2Lm1wND9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAzMDclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMzA3VDAzMjIzOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdiZjFkNjlmYWNjMmEzOTliM2Y3M2VlYjgyNDRlZDJmOWE3NWZhZjE1MzhiZWY4YmQ3NjdkNTYwYTU5ZDA2MzYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.UuHQCgWYkh0OQq9qsUWqGsUbhG3i9jcZDAMeHjLt5T4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px; min-height: 200px"></video>
23-
24-
## Installation
25-
26-
We provide two installation methods. Method 2 (using uv) is recommended for faster installation and better dependency management.
27-
28-
### Method 1: Using conda
29-
30-
1. Create a new conda environment:
31-
32-
```bash
33-
conda create -n open_manus python=3.12
34-
conda activate open_manus
35-
```
36-
37-
2. Clone the repository:
38-
39-
```bash
40-
git clone https://github.com/mannaandpoem/OpenManus.git
41-
cd OpenManus
42-
```
43-
44-
3. Install dependencies:
45-
46-
```bash
47-
pip install -r requirements.txt
48-
```
49-
50-
### Method 2: Using uv (Recommended)
51-
52-
1. Install uv (A fast Python package installer and resolver):
53-
54-
```bash
55-
curl -LsSf https://astral.sh/uv/install.sh | sh
56-
```
57-
58-
2. Clone the repository:
59-
60-
```bash
61-
git clone https://github.com/mannaandpoem/OpenManus.git
62-
cd OpenManus
63-
```
64-
65-
3. Create a new virtual environment and activate it:
66-
67-
```bash
68-
uv venv
69-
source .venv/bin/activate # On Unix/macOS
70-
# Or on Windows:
71-
# .venv\Scripts\activate
72-
```
73-
74-
4. Install dependencies:
75-
76-
```bash
77-
uv pip install -r requirements.txt
78-
```
79-
80-
## Configuration
81-
82-
OpenManus requires configuration for the LLM APIs it uses. Follow these steps to set up your configuration:
83-
84-
1. Create a `config.toml` file in the `config` directory (you can copy from the example):
85-
86-
```bash
87-
cp config/config.example.toml config/config.toml
88-
```
89-
90-
2. Edit `config/config.toml` to add your API keys and customize settings:
91-
92-
```toml
93-
# Global LLM configuration
94-
[llm]
95-
model = "gpt-4o"
96-
base_url = "https://api.openai.com/v1"
97-
api_key = "sk-..." # Replace with your actual API key
98-
max_tokens = 4096
99-
temperature = 0.0
100-
101-
# Optional configuration for specific LLM models
102-
[llm.vision]
103-
model = "gpt-4o"
104-
base_url = "https://api.openai.com/v1"
105-
api_key = "sk-..." # Replace with your actual API key
106-
```
107-
108-
## Quick Start
109-
110-
One line for run OpenManus:
111-
112-
```bash
113-
python main.py
114-
```
115-
116-
Then input your idea via terminal!
117-
118-
For unstable version, you also can run:
119-
120-
```bash
121-
python run_flow.py
122-
```
123-
124-
## How to contribute
125-
126-
We welcome any friendly suggestions and helpful contributions! Just create issues or submit pull requests.
127-
128-
Or contact @mannaandpoem via 📧email: [email protected]
129-
130-
## Community Group
131-
Join our networking group on Feishu and share your experience with other developers!
132-
133-
<div align="center" style="display: flex; gap: 20px;">
134-
<img src="assets/community_group.jpg" alt="OpenManus 交流群" width="300" />
135-
</div>
136-
137-
## Star History
138-
139-
[![Star History Chart](https://api.star-history.com/svg?repos=mannaandpoem/OpenManus&type=Date)](https://star-history.com/#mannaandpoem/OpenManus&Date)
140-
141-
## Acknowledgement
142-
143-
Thanks to [anthropic-computer-use](https://github.com/anthropics/anthropic-quickstarts/tree/main/computer-use-demo)
144-
and [browser-use](https://github.com/browser-use/browser-use) for providing basic support for this project!
145-
146-
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).
147-
148-
OpenManus is built by contributors from MetaGPT. Huge thanks to this agent community!
149-
150-
## Cite
151-
```bibtex
152-
@misc{openmanus2025,
153-
author = {Xinbin Liang and Jinyu Xiang and Zhaoyang Yu and Jiayi Zhang and Sirui Hong},
154-
title = {OpenManus: An open-source framework for building general AI agents},
155-
year = {2025},
156-
publisher = {GitHub},
157-
journal = {GitHub repository},
158-
howpublished = {\url{https://github.com/mannaandpoem/OpenManus}},
159-
}
160-
```
1+
<br>
2+
3+
<details>
4+
<summary>🌐 Other Languages</summary>
5+
6+
- English
7+
- [中文](README_zh.md)
8+
- [한국어](README_ko.md)
9+
10+
</details>
11+
12+
[![GitHub stars](https://img.shields.io/github/stars/mannaandpoem/OpenManus?style=social)](https://github.com/mannaandpoem/OpenManus/stargazers)
13+
&ensp;
14+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) &ensp;
15+
[![Discord Follow](https://dcbadge.vercel.app/api/server/DYn29wFk9z?style=flat)](https://discord.gg/DYn29wFk9z)
16+
17+
# 👋 OpenManus
18+
19+
Manus is incredible, but OpenManus can achieve any idea without an *Invite Code* 🛫!
20+
21+
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!
22+
23+
It's a simple implementation, so we welcome any suggestions, contributions, and feedback!
24+
25+
Enjoy your own agent with OpenManus!
26+
27+
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.
28+
29+
## Project Demo
30+
31+
<video src="https://private-user-images.githubusercontent.com/61239030/420168772-6dcfd0d2-9142-45d9-b74e-d10aa75073c6.mp4?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NDEzMTgwNTksIm5iZiI6MTc0MTMxNzc1OSwicGF0aCI6Ii82MTIzOTAzMC80MjAxNjg3NzItNmRjZmQwZDItOTE0Mi00NWQ5LWI3NGUtZDEwYWE3NTA3M2M2Lm1wND9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAzMDclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMzA3VDAzMjIzOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdiZjFkNjlmYWNjMmEzOTliM2Y3M2VlYjgyNDRlZDJmOWE3NWZhZjE1MzhiZWY4YmQ3NjdkNTYwYTU5ZDA2MzYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.UuHQCgWYkh0OQq9qsUWqGsUbhG3i9jcZDAMeHjLt5T4" data-canonical-src="https://private-user-images.githubusercontent.com/61239030/420168772-6dcfd0d2-9142-45d9-b74e-d10aa75073c6.mp4?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NDEzMTgwNTksIm5iZiI6MTc0MTMxNzc1OSwicGF0aCI6Ii82MTIzOTAzMC80MjAxNjg3NzItNmRjZmQwZDItOTE0Mi00NWQ5LWI3NGUtZDEwYWE3NTA3M2M2Lm1wND9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAzMDclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMzA3VDAzMjIzOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdiZjFkNjlmYWNjMmEzOTliM2Y3M2VlYjgyNDRlZDJmOWE3NWZhZjE1MzhiZWY4YmQ3NjdkNTYwYTU5ZDA2MzYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.UuHQCgWYkh0OQq9qsUWqGsUbhG3i9jcZDAMeHjLt5T4" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" style="max-height:640px; min-height: 200px"></video>
32+
33+
## Installation
34+
35+
We provide two installation methods. Method 2 (using uv) is recommended for faster installation and better dependency management.
36+
37+
### Method 1: Using conda
38+
39+
1. Create a new conda environment:
40+
41+
```bash
42+
conda create -n open_manus python=3.12
43+
conda activate open_manus
44+
```
45+
46+
2. Clone the repository:
47+
48+
```bash
49+
git clone https://github.com/mannaandpoem/OpenManus.git
50+
cd OpenManus
51+
```
52+
53+
3. Install dependencies:
54+
55+
```bash
56+
pip install -r requirements.txt
57+
```
58+
59+
### Method 2: Using uv (Recommended)
60+
61+
1. Install uv (A fast Python package installer and resolver):
62+
63+
```bash
64+
curl -LsSf https://astral.sh/uv/install.sh | sh
65+
```
66+
67+
2. Clone the repository:
68+
69+
```bash
70+
git clone https://github.com/mannaandpoem/OpenManus.git
71+
cd OpenManus
72+
```
73+
74+
3. Create a new virtual environment and activate it:
75+
76+
```bash
77+
uv venv
78+
source .venv/bin/activate # On Unix/macOS
79+
# Or on Windows:
80+
# .venv\Scripts\activate
81+
```
82+
83+
4. Install dependencies:
84+
85+
```bash
86+
uv pip install -r requirements.txt
87+
```
88+
89+
## Configuration
90+
91+
OpenManus requires configuration for the LLM APIs it uses. Follow these steps to set up your configuration:
92+
93+
1. Create a `config.toml` file in the `config` directory (you can copy from the example):
94+
95+
```bash
96+
cp config/config.example.toml config/config.toml
97+
```
98+
99+
2. Edit `config/config.toml` to add your API keys and customize settings:
100+
101+
```toml
102+
# Global LLM configuration
103+
[llm]
104+
model = "gpt-4o"
105+
base_url = "https://api.openai.com/v1"
106+
api_key = "sk-..." # Replace with your actual API key
107+
max_tokens = 4096
108+
temperature = 0.0
109+
110+
# Optional configuration for specific LLM models
111+
[llm.vision]
112+
model = "gpt-4o"
113+
base_url = "https://api.openai.com/v1"
114+
api_key = "sk-..." # Replace with your actual API key
115+
```
116+
117+
## Quick Start
118+
119+
One line for run OpenManus:
120+
121+
```bash
122+
python main.py
123+
```
124+
125+
Then input your idea via terminal!
126+
127+
For unstable version, you also can run:
128+
129+
```bash
130+
python run_flow.py
131+
```
132+
133+
## How to contribute
134+
135+
We welcome any friendly suggestions and helpful contributions! Just create issues or submit pull requests.
136+
137+
Or contact @mannaandpoem via 📧email: [email protected]
138+
139+
## Community Group
140+
Join our networking group on Feishu and share your experience with other developers!
141+
142+
<div align="center" style="display: flex; gap: 20px;">
143+
<img src="assets/community_group.jpg" alt="OpenManus 交流群" width="300" />
144+
</div>
145+
146+
## Star History
147+
148+
[![Star History Chart](https://api.star-history.com/svg?repos=mannaandpoem/OpenManus&type=Date)](https://star-history.com/#mannaandpoem/OpenManus&Date)
149+
150+
## Acknowledgement
151+
152+
Thanks to [anthropic-computer-use](https://github.com/anthropics/anthropic-quickstarts/tree/main/computer-use-demo)
153+
and [browser-use](https://github.com/browser-use/browser-use) for providing basic support for this project!
154+
155+
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).
156+
157+
OpenManus is built by contributors from MetaGPT. Huge thanks to this agent community!
158+
159+
## Cite
160+
```bibtex
161+
@misc{openmanus2025,
162+
author = {Xinbin Liang and Jinyu Xiang and Zhaoyang Yu and Jiayi Zhang and Sirui Hong},
163+
title = {OpenManus: An open-source framework for building general AI agents},
164+
year = {2025},
165+
publisher = {GitHub},
166+
journal = {GitHub repository},
167+
howpublished = {\url{https://github.com/mannaandpoem/OpenManus}},
168+
}
169+
```

0 commit comments

Comments
 (0)