README_CN.md

MetaGPT: 多智能体框架

使 GPTs 组成软件公司，协作处理更复杂的任务

1. MetaGPT输入一句话的老板需求，输出用户故事 / 竞品分析 / 需求 / 数据结构 / APIs / 文件等
2. MetaGPT内部包括产品经理 / 架构师 / 项目经理 / 工程师，它提供了一个软件公司的全过程与精心调配的SOP
   1. Code = SOP(Team) 是核心哲学。我们将SOP具象化，并且用于LLM构成的团队

软件公司多角色示意图（正在逐步实现）

安装

Pip安装

# 第 1 步：确保您的系统上安装了 Python 3.9+。您可以使用以下命令进行检查：
# 可以使用conda来初始化新的python环境
#     conda create -n metagpt python=3.9
#     conda activate metagpt
python3 --version

# 第 2 步：克隆最新仓库到您的本地机器，并进行安装。
git clone https://github.com/geekan/MetaGPT.git
cd MetaGPT
pip3 install -e.  # 或者 pip3 install metagpt  # 安装稳定版本

# 第 3 步：执行metagpt
# 拷贝config.yaml为key.yaml，并设置你自己的OPENAI_API_KEY
metagpt "Write a cli snake game"

# 第 4 步【可选的】：如果你想在执行过程中保存像象限图、系统设计、序列流程等图表这些产物，可以在第3步前执行该步骤。默认的，框架做了兼容，在不执行该步的情况下，也可以完整跑完整个流程。
# 如果执行，确保您的系统上安装了 NPM。并使用npm安装mermaid-js
npm --version
sudo npm install -g @mermaid-js/mermaid-cli

详细的安装请安装 cli_install

Docker安装

注意：在Windows中，你需要将 "/opt/metagpt" 替换为Docker具有创建权限的目录，比如"D:\Users\x\metagpt"

# 步骤1: 下载metagpt官方镜像并准备好config.yaml
docker pull metagpt/metagpt:latest
mkdir -p /opt/metagpt/{config,workspace}
docker run --rm metagpt/metagpt:latest cat /app/metagpt/config/config.yaml > /opt/metagpt/config/key.yaml
vim /opt/metagpt/config/key.yaml # 修改配置文件

# 步骤2: 使用容器运行metagpt演示
docker run --rm \
    --privileged \
    -v /opt/metagpt/config/key.yaml:/app/metagpt/config/key.yaml \
    -v /opt/metagpt/workspace:/app/metagpt/workspace \
    metagpt/metagpt:latest \
    metagpt "Write a cli snake game"

详细的安装请安装 docker_install

快速开始的演示视频

• 在 MetaGPT Huggingface Space 上进行体验
• Matthew Berman: How To Install MetaGPT - Build A Startup With One Prompt!!
• 官方演示视频

customized_tasks_by_MetaGPT_v2.mp4

教程

• 🗒 在线文档
• 💻 如何使用
• 🔎 MetaGPT的能力及应用场景
• 🛠 如何构建你自己的智能体？
  • MetaGPT的使用和开发教程 | 智能体入门
  • MetaGPT的使用和开发教程 | 多智能体入门
• 🧑‍💻 贡献
  • 开发路线图
• 🔖 示例
  • 辩论
  • 调研员
  • 票据助手
• ❓ 常见问题解答

支持

加入我们

📢 加入我们的Discord频道！

期待在那里与您相见！🎉

联系信息

如果您对这个项目有任何问题或反馈，欢迎联系我们。我们非常欢迎您的建议！

• 邮箱： [email protected]
• GitHub 问题： 对于更技术性的问题，您也可以在我们的 GitHub 仓库 中创建一个新的问题。

我们会在2-3个工作日内回复所有问题。

引用

引用 arXiv paper:

@misc{hong2023metagpt,
      title={MetaGPT: Meta Programming for Multi-Agent Collaborative Framework},
      author={Sirui Hong and Xiawu Zheng and Jonathan Chen and Yuheng Cheng and Jinlin Wang and Ceyao Zhang and Zili Wang and Steven Ka Shing Yau and Zijuan Lin and Liyang Zhou and Chenyu Ran and Lingfeng Xiao and Chenglin Wu},
      year={2023},
      eprint={2308.00352},
      archivePrefix={arXiv},
      primaryClass={cs.AI}
}