diff --git a/README.md b/README.md index d4a8437..5021a4c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/FoundationAgents/OpenManus) · [上游 README](https://github.com/FoundationAgents/OpenManus/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +

-English | [中文](README_zh.md) | [한국어](README_ko.md) | [日本語](README_ja.md) +[English](README.md) | 中文 | [한국어](README_ko.md) | [日本語](README_ja.md) [![GitHub stars](https://img.shields.io/github/stars/FoundationAgents/OpenManus?style=social)](https://github.com/FoundationAgents/OpenManus/stargazers)   @@ -13,179 +19,182 @@ English | [中文](README_zh.md) | [한국어](README_ko.md) | [日本語](READM # 👋 OpenManus -Manus is incredible, but OpenManus can achieve any idea without an *Invite Code* 🛫! +Manus 非常棒，但 OpenManus 无需邀请码即可实现任何创意 🛫！ -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! +我们的团队成员 [@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 +小时内完成了开发并持续迭代中！ -It's a simple implementation, so we welcome any suggestions, contributions, and feedback! +这是一个简洁的实现方案，欢迎任何建议、贡献和反馈！ -Enjoy your own agent with OpenManus! +用 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. +我们也非常高兴地向大家介绍 [OpenManus-RL](https://github.com/OpenManus/OpenManus-RL)，这是一个专注于基于强化学习（RL，例如 GRPO）的方法来优化大语言模型（LLM）智能体的开源项目，由来自UIUC 和 OpenManus 的研究人员合作开发。 -## Project Demo +## 项目演示 -## Installation +## 安装指南 -We provide two installation methods. Method 2 (using uv) is recommended for faster installation and better dependency management. +我们提供两种安装方式。推荐使用方式二（uv），因为它能提供更快的安装速度和更好的依赖管理。 -### Method 1: Using conda +### 方式一：使用 conda -1. Create a new conda environment: +1. 创建新的 conda 环境： ```bash conda create -n open_manus python=3.12 conda activate open_manus ``` -2. Clone the repository: +2. 克隆仓库： ```bash git clone https://github.com/FoundationAgents/OpenManus.git cd OpenManus ``` -3. Install dependencies: +3. 安装依赖： ```bash pip install -r requirements.txt ``` -### Method 2: Using uv (Recommended) +### 方式二：使用 uv（推荐） -1. Install uv (A fast Python package installer and resolver): +1. 安装 uv（一个快速的 Python 包管理器）： ```bash curl -LsSf https://astral.sh/uv/install.sh | sh ``` -2. Clone the repository: +2. 克隆仓库： ```bash git clone https://github.com/FoundationAgents/OpenManus.git cd OpenManus ``` -3. Create a new virtual environment and activate it: +3. 创建并激活虚拟环境： ```bash uv venv --python 3.12 -source .venv/bin/activate # On Unix/macOS -# Or on Windows: +source .venv/bin/activate # Unix/macOS 系统 +# Windows 系统使用： # .venv\Scripts\activate ``` -4. Install dependencies: +4. 安装依赖： ```bash uv pip install -r requirements.txt ``` -### Browser Automation Tool (Optional) +### 浏览器自动化工具（可选） ```bash playwright install ``` -## Configuration +## 配置说明 -OpenManus requires configuration for the LLM APIs it uses. Follow these steps to set up your configuration: +OpenManus 需要配置使用的 LLM API，请按以下步骤设置： -1. Create a `config.toml` file in the `config` directory (you can copy from the example): +1. 在 `config` 目录创建 `config.toml` 文件（可从示例复制）： ```bash cp config/config.example.toml config/config.toml ``` -2. Edit `config/config.toml` to add your API keys and customize settings: +2. 编辑 `config/config.toml` 添加 API 密钥和自定义设置： ```toml -# Global LLM configuration +# 全局 LLM 配置 [llm] model = "gpt-4o" base_url = "https://api.openai.com/v1" -api_key = "sk-..." # Replace with your actual API key +api_key = "sk-..." # 替换为真实 API 密钥 max_tokens = 4096 temperature = 0.0 -# Optional configuration for specific LLM models +# 可选特定 LLM 模型配置 [llm.vision] model = "gpt-4o" base_url = "https://api.openai.com/v1" -api_key = "sk-..." # Replace with your actual API key +api_key = "sk-..." # 替换为真实 API 密钥 ``` -## Quick Start +## 快速启动 -One line for run OpenManus: +一行命令运行 OpenManus： ```bash python main.py ``` -Then input your idea via terminal! +然后通过终端输入你的创意！ -For MCP tool version, you can run: +如需使用 MCP 工具版本，可运行： ```bash python run_mcp.py ``` -For unstable multi-agent version, you also can run: +如需体验不稳定的多智能体版本，可运行： ```bash python run_flow.py ``` -### Custom Adding Multiple Agents - -Currently, besides the general OpenManus Agent, we have also integrated the DataAnalysis Agent, which is suitable for data analysis and data visualization tasks. You can add this agent to `run_flow` in `config.toml`. +## 添加自定义多智能体 +目前除了通用的 OpenManus Agent, 我们还内置了DataAnalysis Agent，适用于数据分析和数据可视化任务，你可以在`config.toml`中将这个智能体加入到`run_flow`中 ```toml -# Optional configuration for run-flow +# run-flow可选配置 [runflow] -use_data_analysis_agent = true # Disabled by default, change to true to activate +use_data_analysis_agent = true # 默认关闭，将其改为true则为激活 ``` -In addition, you need to install the relevant dependencies to ensure the agent runs properly: [Detailed Installation Guide](app/tool/chart_visualization/README.md##Installation) +除此之外，你还需要安装相关的依赖来确保智能体正常运行：[具体安装指南](app/tool/chart_visualization/README_zh.md##安装) -## 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 +我们欢迎任何友好的建议和有价值的贡献！可以直接创建 issue 或提交 pull request。 -**Note**: Before submitting a pull request, please use the pre-commit tool to check your changes. Run `pre-commit run --all-files` to execute the checks. +或通过 📧 邮件联系 @mannaandpoem：mannaandpoem@gmail.com -## Community Group -Join our networking group on Feishu and share your experience with other developers! +**注意**: 在提交 pull request 之前，请使用 pre-commit 工具检查您的更改。运行 `pre-commit run --all-files` 来执行检查。 + +## 交流群 + +加入我们的飞书交流群，与其他开发者分享经验！
OpenManus 交流群
-## Star History +## Star 数量 [![Star History Chart](https://api.star-history.com/svg?repos=FoundationAgents/OpenManus&type=Date)](https://star-history.com/#FoundationAgents/OpenManus&Date) -## Sponsors -Thanks to [PPIO](https://ppinfra.com/user/register?invited_by=OCPKCN&utm_source=github_openmanus&utm_medium=github_readme&utm_campaign=link) for computing source support. -> PPIO: The most affordable and easily-integrated MaaS and GPU cloud solution. +## 赞助商 +感谢[PPIO](https://ppinfra.com/user/register?invited_by=OCPKCN&utm_source=github_openmanus&utm_medium=github_readme&utm_campaign=link) 提供的算力支持。 +> PPIO派欧云：一键调用高性价比的开源模型API和GPU容器 -## Acknowledgement +## 致谢 -Thanks to [anthropic-computer-use](https://github.com/anthropics/anthropic-quickstarts/tree/main/computer-use-demo), [browser-use](https://github.com/browser-use/browser-use) and [crawl4ai](https://github.com/unclecode/crawl4ai) for providing basic support for this project! +特别感谢 [anthropic-computer-use](https://github.com/anthropics/anthropic-quickstarts/tree/main/computer-use-demo) +和 [browser-use](https://github.com/browser-use/browser-use) 为本项目提供的基础支持！ -Additionally, we are grateful to [AAAJ](https://github.com/metauto-ai/agent-as-a-judge), [MetaGPT](https://github.com/geekan/MetaGPT), [OpenHands](https://github.com/All-Hands-AI/OpenHands) and [SWE-agent](https://github.com/SWE-agent/SWE-agent). +此外，我们感谢 [AAAJ](https://github.com/metauto-ai/agent-as-a-judge)，[MetaGPT](https://github.com/geekan/MetaGPT)，[OpenHands](https://github.com/All-Hands-AI/OpenHands) 和 [SWE-agent](https://github.com/SWE-agent/SWE-agent). -We also thank stepfun(阶跃星辰) for supporting our Hugging Face demo space. +我们也感谢阶跃星辰 (stepfun) 提供的 Hugging Face 演示空间支持。 -OpenManus is built by contributors from MetaGPT. Huge thanks to this agent community! +OpenManus 由 MetaGPT 社区的贡献者共同构建，感谢这个充满活力的智能体开发者社区！ -## Cite +## 引用 ```bibtex @misc{openmanus2025, - author = {Xinbin Liang and Jinyu Xiang and Zhaoyang Yu and Jiayi Zhang and Sirui Hong and Sheng Fan and Xiao Tang and Bang Liu and Yuyu Luo and Chenglin Wu}, + author = {Xinbin Liang and Jinyu Xiang and Zhaoyang Yu and Jiayi Zhang and Sirui Hong and Sheng Fan and Xiao Tang}, title = {OpenManus: An open-source framework for building general AI agents}, year = {2025}, publisher = {Zenodo},