gpt-engineer

最初的代码生成实验平台！

如果你正在寻找一个经过深思熟虑、托管式的服务——请访问 gptengineer.app。

如果你想要一个维护良好且可扩展的命令行工具——请试试 aider。

gpt-engineer 让你能够：

• 用自然语言描述软件需求
• 坐下来观看 AI 自动编写并执行代码
• 请求 AI 对代码进行改进

快速上手

安装 gpt-engineer

对于 稳定 版本：

• python -m pip install gpt-engineer

对于 开发 版本：

• git clone https://github.com/gpt-engineer-org/gpt-engineer.git
• cd gpt-engineer
• poetry install
• poetry shell 激活虚拟环境

我们目前主要支持 Python 3.10 到 3.12。最后一个支持 Python 3.8 和 3.9 的版本是 0.2.6。

设置 API 密钥

选择 一种 方法：

• 导出环境变量（你可以将其添加到 .bashrc 文件中，这样每次打开终端时就不必重复设置）：
  • export OPENAI_API_KEY=[你的 API 密钥]
• 使用 .env 文件：
  • 复制 .env.template 并重命名为 .env
  • 在 .env 中添加你的 OPENAI_API_KEY
• 自定义模型：
  • 参阅 文档，支持本地模型、Azure 等。

Windows 用户请参考 Windows README。

其他运行方式：

• 使用 Docker（说明）
• 直接在浏览器中操作：

创建新代码（默认用法）

• 在你的电脑任意位置创建一个空文件夹作为项目目录
• 在该文件夹内创建一个名为 prompt 的无扩展名文件，并填写你的需求说明
• 运行 gpte <project_dir>，传入项目文件夹的相对路径
  • 例如：从 gpt-engineer 目录根下运行 gpte projects/my-new-project，其中 my-new-project 是你在 projects/ 下的新文件夹

改进现有代码

• 找到你想要改进的代码所在的文件夹
• 在该文件夹内创建一个名为 prompt 的无扩展名文件，并填写改进要求
• 运行 gpte <project_dir> -i，传入文件夹的相对路径
  • 例如：从 gpt-engineer 目录根下运行 gpte projects/my-old-project -i，其中 my-old-project 是你在 projects/ 下的旧文件夹

自定义智能体基准测试

• gpt-engineer 会安装一个名为 bench 的二进制文件，它提供了一个简单的界面，用于将你自己的智能体实现与流行的公开数据集进行基准测试。
• 开始基准测试最简单的方式是查看 模板 仓库，其中包含详细的说明和智能体模板。
• 目前支持的基准测试：
  • APPS
  • MBPP

社区已经启动了多项基准测试计划，详情请参见 这段 Loom 视频。

研究

我们的部分社区成员曾参与过一些研究课题，这些课题仍可进一步推进。如果你感兴趣，请查阅 这份文档。

条款

运行 gpt-engineer 即表示你同意我们的 使用条款。

与 gptengineer.app 的关系

gptengineer.app 是一个用于自动生成 Web 应用的商业项目。 它为非技术人员提供了一个 UI 界面，并与基于 Git 的代码库相连。 gptengineer.app 团队也在积极支持开源社区。

功能

预提示

你可以通过覆盖 preprompts 文件夹来指定 AI 代理的“身份”。只需使用 --use-custom-preprompts 参数即可。

编辑 preprompts 文件可以帮助智能体在不同项目之间记住相关信息。

视觉功能

默认情况下，gpt-engineer 期望通过 prompt 文件接收文本输入。它也可以接受具备视觉能力的模型的图像输入。这对于将 UX 或架构图作为额外上下文传递给 GPT Engineer 非常有用。你可以通过指定 —-image_directory 标志来使用图像目录，并在第二个 CLI 参数中设置支持视觉功能的模型。 例如：gpte projects/example-vision gpt-4-vision-preview --prompt_file prompt/text --image_directory prompt/images -i

开源、本地及其他替代模型

默认情况下，gpt-engineer 支持通过 OpenAI API 或 Azure OpenAI API 的 OpenAI 模型，以及 Anthropic 模型。 经过少量额外配置，你还可以使用开源模型，如 WizardCoder。具体操作请参阅 文档。

使命

gpt-engineer 社区的使命是 维护编码智能体开发者可用的工具，并促进开源社区内的协作。

如果你有兴趣为此做出贡献，我们非常欢迎你加入。

如果你想了解我们的更长远目标，请查看 路线图，并加入 Discord 以了解如何参与贡献（参阅 .github/CONTRIBUTING.md）。

gpt-engineer 由一个长期贡献者组成的理事会进行管理。如果你能持续贡献并对 gpt-engineer 的未来发展感兴趣，我们将考虑让你加入理事会。

重要贡献者

• @ATheorell
• @similato87
• @TheoMcCabe
• @captivus

示例

https://github.com/gpt-engineer-org/gpt-engineer/assets/4467025/40d0a9a8-82d0-4432-9376-136df0d57c99

gpt-engineer 快速上手指南

gpt-engineer 是一款开源的 AI 代码生成实验平台，允许你通过自然语言描述软件需求，AI 将自动编写并执行代码，同时支持迭代改进。

环境准备

• 操作系统：Linux、macOS 或 Windows（Windows 用户建议参考官方 WINDOWS_README.md）
• Python 版本：推荐 Python 3.10 - 3.12
  • 注：若需使用 Python 3.8 或 3.9，请安装版本 0.2.6
• 前置依赖：
  • pip 或 Poetry（开发模式需要）
  • Git（开发模式需要）
  • OpenAI API Key（或其他兼容模型的 API Key）

安装步骤

方式一：安装稳定版（推荐）

直接使用 pip 安装：

python -m pip install gpt-engineer

方式二：开发模式安装

如果你希望贡献代码或体验最新功能：

git clone https://github.com/gpt-engineer-org/gpt-engineer.git
cd gpt-engineer
poetry install
poetry shell

基本使用

1. 配置 API Key

在使用前，必须配置大模型 API 密钥。任选以下一种方式：

方法 A：设置环境变量

export OPENAI_API_KEY=[你的 API 密钥]
# 可将此命令加入 .bashrc 或 .zshrc 以永久生效

方法 B：使用 .env 文件

cp .env.template .env
# 编辑 .env 文件，填入你的 OPENAI_API_KEY

注：也支持 Azure、本地模型等自定义配置，详见官方文档。

2. 创建新项目（从零生成代码）

1. 在任意位置创建一个空文件夹作为项目目录。
2. 在该文件夹内创建一个名为 prompt 的文件（无后缀名）。
3. 在 prompt 文件中用自然语言写下你的需求（例如：“创建一个贪吃蛇游戏”）。
4. 运行以下命令（替换 <项目文件夹路径> 为实际路径）：

gpte <项目文件夹路径>

示例： 假设你在当前目录下有一个 projects/my-game 文件夹：

gpte projects/my-game

AI 将读取指令，自动生成代码文件并在终端显示执行过程。

3. 改进现有代码

如果你想让 AI 优化已有的代码库：

1. 找到包含代码的文件夹。
2. 在该文件夹内创建 prompt 文件，写下改进指令（例如：“添加得分记录功能”）。
3. 运行命令时加上 -i 参数：

gpte <项目文件夹路径> -i

示例：

gpte projects/old-project -i

---

提示：gpt-engineer 还支持视觉输入（通过 --image_directory 上传架构图）和自定义预提示词（preprompts），更多高级用法请参考官方完整文档。