gpt-engineer

代码生成实验平台的鼻祖！

如果你正在寻找一个具有特定倾向的托管服务进化版，请查看 gptengineer.app。

如果你正在寻找一个维护良好的可定制化 CLI 工具，请查看 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 key

选择以下一种方式即可：

• 导出环境变量（可以将其添加到 .bashrc 中，这样就无需每次启动终端时重复设置）
  • export OPENAI_API_KEY=[your api key]
• .env 文件：
  • 创建一个 .env.template 的副本并命名为 .env
  • 在 .env 文件中填入你的 OPENAI_API_KEY
• 自定义模型：
  • 请查看 文档，支持本地模型、Azure 等。

Windows 用户请参阅 Windows README。

其他运行方式：

• 使用 Docker (说明)
• 直接在浏览器中运行：

创建新代码（默认用法）

• 在电脑上的任意位置创建一个空文件夹，用于存放你的项目
• 在新文件夹中创建一个名为 prompt 的文件（无需扩展名），并在其中填入指令
• 使用指向你文件夹的相对路径运行 gpte
  • 例如：从 gpt-engineer 目录根路径运行 gpte projects/my-new-project，前提是你的新文件夹位于 projects/ 下

改进现有代码

• 在电脑上定位到你想要改进的代码所在文件夹
• 在该文件夹内创建一个名为 prompt 的文件（无需扩展名），并在其中填入关于如何改进代码的指令
• 使用指向你文件夹的相对路径运行 gpte -i
  • 例如：从 gpt-engineer 目录根路径运行 gpte projects/my-old-project -i

基准测试自定义 Agent

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

社区已开始开展不同的基准测试计划，详情请参阅 此 Loom 视频。

研究

我们的一些社区成员致力于不同的研究课题，这些课题可以进一步深入。如果你感兴趣，请查看 此文档。

条款

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

与 gptengineer.app (GPT Engineer) 的关系

gptengineer.app 是一个用于自动生成 Web 应用的商业项目。它为非技术用户提供了一个连接到 Git 代码库的 UI。gptengineer.app 团队正在积极支持开源社区。

功能特性

预设提示词 (Pre Prompts)

你可以通过覆盖 preprompts 文件夹中的内容来指定 AI Agent 的“身份”。你可以通过 --use-custom-preprompts 参数来实现这一点。

编辑 preprompts 是让 Agent 在项目之间保持记忆力的方式。

Vision

默认情况下，gpt-engineer 期望通过文本输入。