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 密钥

选择 一种 方式：
- 导出环境变量（可添加到 .bashrc 中，避免每次启动终端都需设置）
- export OPENAI_API_KEY=[你的 api 密钥]
- 使用 .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，前提是你的文件夹位于 projects/ 下

基准测试自定义智能体

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

社区已开始进行不同的基准测试计划，如此 Loom 视频所述。

研究

我们的一些社区成员已经完成了不同的研究简报，可以进一步深入。如果你有兴趣，请查看此文档。

条款

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

与 gptengineer.app (GPT Engineer) 的关系

gptengineer.app 是一个用于自动生成 Web 应用的商业项目。
它为非技术用户提供了一个连接至 Git 控制代码库的 UI。
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
来了解如何贡献。

gpt-engineer 由长期贡献者组成的理事会进行治理。如果你定期贡献并有兴趣塑造 gpt-engineer 的未来，你将被考虑加入理事会。

重要贡献者

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

示例

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