README_CN.md

MetaGPT: 多智能体框架

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

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

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

示例（均由 GPT-4 生成）

例如，键入python startup.py "写个类似今日头条的推荐系统"并回车，你会获得一系列输出，其一是数据结构与API设计

这需要大约0.2美元（GPT-4 API的费用）来生成一个带有分析和设计的示例，大约2.0美元用于一个完整的项目

安装

传统安装

# 第 1 步：确保您的系统上安装了 NPM。并使用npm安装mermaid-js
npm --version
sudo npm install -g @mermaid-js/mermaid-cli

# 第 2 步：确保您的系统上安装了 Python 3.9+。您可以使用以下命令进行检查：
python --version

# 第 3 步：克隆仓库到您的本地机器，并进行安装。
git clone https://github.com/geekan/metagpt
cd metagpt
python setup.py install

Docker安装

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

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

# 您也可以启动一个容器并在其中执行命令
docker run --name metagpt -d \
    --privileged \
    -v /opt/metagpt/config:/app/metagpt/config \
    -v /opt/metagpt/workspace:/app/metagpt/workspace \
    metagpt/metagpt:v0.3

docker exec -it metagpt /bin/bash
$ python startup.py "Write a cli snake game"

docker run ...做了以下事情:

• 以特权模式运行，有权限运行浏览器
• 将主机目录 /opt/metagpt/config 映射到容器目录/app/metagpt/config
• 将主机目录 /opt/metagpt/workspace 映射到容器目录 /app/metagpt/workspace
• 执行演示命令 python startup.py "Write a cli snake game"

自己构建镜像

# 您也可以自己构建metagpt镜像
git clone https://github.com/geekan/MetaGPT.git
cd MetaGPT && docker build -t metagpt:v0.3 .

配置

• 在 config/key.yaml / config/config.yaml / env 中配置您的 OPENAI_API_KEY
• 优先级顺序：config/key.yaml > config/config.yaml > env

# 复制配置文件并进行必要的修改
cp config/config.yaml config/key.yaml

变量名	config/key.yaml	env
OPENAI_API_KEY # 用您自己的密钥替换	OPENAI_API_KEY: "sk-..."	export OPENAI_API_KEY="sk-..."
OPENAI_API_BASE # 可选	OPENAI_API_BASE: "https://<YOUR_SITE>/v1"	export OPENAI_API_BASE="https://<YOUR_SITE>/v1"

示例：启动一个创业公司

python startup.py "写一个命令行贪吃蛇"
# 开启code review模式会会花费更多的money, 但是会提升代码质量和成功率
python startup.py "写一个命令行贪吃蛇" --code_review True

运行脚本后，您可以在 workspace/ 目录中找到您的新项目。

平台或工具的倾向性

可以在阐述需求时说明想要使用的平台或工具。 例如：

python startup.py "写一个基于pygame的命令行贪吃蛇"

使用

名称
    startup.py - 我们是一家AI软件创业公司。通过投资我们，您将赋能一个充满无限可能的未来。

概要
    startup.py IDEA <flags>

描述
    我们是一家AI软件创业公司。通过投资我们，您将赋能一个充满无限可能的未来。

位置参数
    IDEA
        类型: str
        您的创新想法，例如"写一个命令行贪吃蛇。"

标志
    --investment=INVESTMENT
        类型: float
        默认值: 3.0
        作为投资者，您有机会向这家AI公司投入一定的美元金额。
    --n_round=N_ROUND
        类型: int
        默认值: 5

备注
    您也可以用`标志`的语法，来处理`位置参数`

代码实现

from metagpt.software_company import SoftwareCompany
from metagpt.roles import ProjectManager, ProductManager, Architect, Engineer

async def startup(idea: str, investment: float = 3.0, n_round: int = 5):
    """运行一个创业公司。做一个老板"""
    company = SoftwareCompany()
    company.hire([ProductManager(), Architect(), ProjectManager(), Engineer()])
    company.invest(investment)
    company.start_project(idea)
    await company.run(n_round=n_round)

你可以查看examples，其中有单角色（带知识库）的使用例子与仅LLM的使用例子。

快速体验

对一些用户来说，安装配置本地环境是有困难的，下面这些教程能够让你快速体验到MetaGPT的魅力。

• MetaGPT快速体验

联系信息

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

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

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

演示

demo-cli-blackjack-compress.mp4

加入微信讨论群

添加运营小姐姐，拉你入群