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=[你的 api key]
• 使用 .env 文件：
  • 创建 .env.template 的副本并命名为 .env
  • 在 .env 文件中添加你的 OPENAI_API_KEY
• 自定义模型：
  • 请参考 文档，支持本地模型、Azure 等。

Windows 用户请查看 Windows README。

其他运行方式：

• 使用 Docker (指南)
• 在浏览器中完成所有操作：

创建新代码（默认用法）

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

改进现有代码

• 在电脑上找到你想要改进的代码文件夹
• 在文件夹中创建一个名为 prompt 的文件（无后缀名），并在其中填入关于如何改进代码的指令
• 使用指向你文件夹的相对路径运行 gpte -i
  • 例如：在 gpt-engineer 目录根目录下，且你的文件夹位于 projects/ 中，运行 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 期望通过文本输入。