gpt-engineer

一、GPT – Engineer项目全面解析

项目简介

GPT – Engineer项目旨在为开发者提供一个基于AI的代码生成实验平台，充分挖掘AI在软件开发中的潜力。

项目目标

1. 自然语言驱动编程：让开发者能够使用自然语言描述软件需求，摆脱传统编程中复杂的语法和代码结构束缚，降低编程门槛，使更多非专业编程人员也能参与到软件开发中。例如，开发者只需在prompt文件中用自然语言描述“创建一个简单的Python Flask应用，实现用户登录功能”，就有望借助该项目生成相应代码。
2. 自动化代码生成与执行：不仅实现代码的自动生成，还能让生成的代码直接执行，形成从需求描述到可用软件的完整流程。这有助于快速验证想法、加速开发周期，减少开发过程中的重复劳动。
3. 促进AI编程协作与创新：作为一个开源项目，吸引全球开发者共同参与，推动AI在编程领域的应用创新，探索AI辅助编程的最佳实践，形成一个活跃的AI编程社区。

项目特点

自然语言交互便捷性

1. 直观的需求表达：开发者无需精通复杂的编程语言和框架知识，仅需使用自然语言在prompt文件中清晰描述软件功能需求，即可启动代码生成流程。这种方式极大地简化了编程接口，使得编程门槛大幅降低，无论是专业开发者快速实现想法，还是初学者尝试编程，都变得更加容易。例如，对于一个简单的文件管理功能，用户可以描述为“写一个Python脚本，能够遍历指定目录下的所有文件，并将文件名和文件大小记录到一个文本文件中”，系统就能据此生成相应代码。
2. 持续改进的交互：可以针对已生成的代码，再次通过自然语言描述改进需求，如“优化上述脚本，使其能够处理子目录，并且在记录文件大小的同时，也记录文件的修改时间”，让开发过程更加灵活和高效。

预提示（Pre Prompts）定制性

1. 自定义AI身份：通过覆盖preprompts文件夹中的内容，并使用--use - custom - preprompts参数，开发者能够为AI代理指定特定的“身份”。这意味着可以让AI在代码生成过程中遵循特定的风格、规范或具备特定的知识背景。比如，在开发一个金融领域的应用时，可以定制预提示，让AI了解金融行业的术语和常见的业务逻辑，从而生成更符合行业需求的代码。
2. 项目间记忆延续：编辑预提示还能使AI在不同项目之间记住特定的信息，有助于保持项目开发风格的一致性，以及复用一些通用的开发逻辑和知识。

多模态输入支持（Vision）

1. 图像输入辅助：除了传统的文本输入，GPT – Engineer还支持图像输入，对于具备视觉能力的模型而言，这是一个强大的功能扩展。例如，在开发一个用户界面（UI）时，可以提供UX设计草图或架构图作为图像输入，为AI生成代码提供更丰富的上下文信息，使生成的代码更贴合设计预期。
2. 灵活的参数设置：通过——image_directory标志指定图像目录，并在第二个CLI参数中设置支持视觉的模型，如gpte projects/example - vision gpt - 4 - vision - preview --prompt_file prompt/text --image_directory prompt/images - i，即可轻松实现图像输入与文本提示的结合使用。

开源与模型多样性

1. 开源生态优势：项目遵循开源协议（MIT license），这使得全球开发者可以自由获取、使用和修改代码。一方面，吸引了众多开发者贡献代码、提出改进建议，加速项目的发展和创新；另一方面，开发者可以根据自身需求定制项目，满足特定场景下的开发需求。
2. 多模型支持：默认支持OpenAI Models（通过OpenAI API或Azure OpenAI API）以及Anthropic模型，同时，经过一些额外设置，还能使用如WizardCoder等开源模型。这种模型多样性为开发者提供了更多选择，根据不同的应用场景、成本预算和数据隐私要求，选择最合适的模型进行代码生成。

技术原理

自然语言处理与代码生成

1. 自然语言理解：当开发者输入自然语言描述的软件需求时，首先会经过自然语言处理（NLP）模块。该模块利用预训练的语言模型（如GPT系列模型）对输入文本进行解析，理解其中的意图、功能要求和关键信息。例如，对于“创建一个Python程序，计算两个数的和”这样的描述，NLP模块会识别出“Python”指定了编程语言，“计算两个数的和”明确了功能需求。
2. 代码生成逻辑：基于对自然语言的理解，系统会在内部构建代码生成逻辑。它会根据目标编程语言的语法规则、常用库和最佳实践，生成相应的代码结构和语句。在生成过程中，会参考预提示（Pre Prompts）中设定的信息，如特定的代码风格、项目特定的逻辑等。例如，如果预提示中设定了使用特定的日志记录库，那么在生成代码时会引入并合理使用该库。

模型交互与选择机制

1. 与OpenAI及其他模型的交互：当使用OpenAI模型时，项目通过调用OpenAI API（或Azure OpenAI API）与模型进行通信。将处理后的自然语言需求发送到模型端，模型依据其训练的知识和算法生成代码响应。对于Anthropic模型，同样有相应的API交互方式。这种与主流模型的集成，借助了这些模型强大的语言处理和代码生成能力。
2. 模型选择依据：开发者可以根据项目需求、成本和性能等因素选择不同的模型。例如，对于对生成质量要求极高、对成本不太敏感的项目，可以选择OpenAI的GPT – 4等高级模型；而对于一些对隐私要求较高、对模型性能要求相对较低的场景，可以选择开源模型，并在本地部署运行，以满足数据隐私和特定计算资源的限制。

代码执行与验证

1. 代码执行环境：生成的代码会在特定的执行环境中运行。该执行环境会根据目标编程语言进行配置，例如对于Python代码，会安装相应的Python解释器和必要的依赖库。在执行过程中，系统会捕获可能出现的错误信息。
2. 验证与反馈：执行结果会反馈给开发者，如果代码执行出现错误，系统会将错误信息一并返回。开发者可以根据这些反馈，再次通过自然语言描述改进需求，让系统重新生成代码，实现一个不断优化的开发循环。

技术创新点对比

与传统的代码生成工具相比，GPT – Engineer的创新点在于其深度融合自然语言处理与代码生成，并且提供了灵活的定制和多模态输入支持。传统代码生成工具往往需要开发者编写特定格式的模板或遵循严格的规则来生成代码，而GPT – Engineer的自然语言交互更加自由和直观。例如，在一些低代码平台中，虽然也能实现一定程度的代码生成，但通常局限于特定的框架和组件，且配置过程相对复杂。而GPT – Engineer可以基于更广泛的自然语言描述生成各种类型的代码，不受特定框架的限制。在多模态输入方面，很少有代码生成工具能够支持图像输入来辅助代码生成，这是GPT – Engineer在技术上的独特优势。

类似项目

Aider

1. 项目简介：Aider是一个易于使用且可定制的命令行工具，同样致力于利用AI辅助编程。它允许开发者在终端中与AI进行交互，通过自然语言描述来生成、修改和理解代码。与GPT – Engineer类似，Aider也支持多种语言，并且注重用户与AI之间的对话式交互体验，帮助开发者快速实现代码需求。不同之处在于，Aider可能在某些特定的功能场景或交互细节上与GPT – Engineer有所差异，例如在代码生成的默认风格、对特定编程语言的优化支持等方面。例如，Aider可能在处理小型脚本的快速生成和修改上有更简洁的交互方式，而GPT – Engineer在复杂项目的整体架构生成方面可能更具优势。

GitHub Copilot

1. 项目简介：GitHub Copilot是GitHub与OpenAI合作开发的一款AI代码助手，它深度集成在GitHub的开发环境中。Copilot能够根据开发者正在编写的代码上下文，实时提供代码建议和自动完成代码片段。它利用OpenAI的Codex模型，对多种编程语言都有很好的支持。与GPT – Engineer相比，GitHub Copilot更侧重于在开发者编写代码的过程中提供实时辅助，而GPT – Engineer更强调从自然语言描述出发，独立生成完整的项目代码。例如，当开发者在GitHub上编写Python代码时，Copilot会根据已有的代码结构和变量命名等信息，智能推荐接下来可能要编写的代码行，而GPT – Engineer可以根据用户的自然语言描述，如“开发一个完整的Web爬虫项目”，生成整个项目的框架和主要代码逻辑。

Tabnine

1. 项目简介：Tabnine是一款基于AI的代码自动完成工具，它可以集成到多种流行的代码编辑器中，如Visual Studio Code、IntelliJ IDEA等。Tabnine通过学习大量的开源代码库，能够根据代码上下文为开发者提供智能的代码补全建议。它支持多种编程语言，并且在代码补全的准确性和速度方面表现出色。与GPT – Engineer不同，Tabnine主要聚焦于代码编写过程中的自动完成功能，帮助开发者快速输入代码，而GPT – Engineer则是从更高层次的自然语言需求出发，实现整个项目的代码生成和开发流程的自动化。例如，在编写Java代码时，Tabnine能快速补全方法调用、变量声明等代码片段，而GPT – Engineer可以根据用户描述“创建一个Java Spring Boot微服务，实现用户订单管理功能”，生成整个微服务项目的代码框架和关键功能代码。

二、gpt – engineer项目使用指南

环境配置

操作系统要求

建议优先使用Linux或macOS系统，以获得更好的兼容性和使用体验。

编程语言环境

该项目基于Python开发，并且官方明确表示积极支持Python 3.10 – 3.12版本。如果你使用的是Python 3.8 – 3.9版本，仅能使用0.2.6及之前的版本。所以，在开始项目之前，请确保你的系统中安装了合适版本的Python环境。

安装依赖

1. 基础依赖：在Python环境安装完成后，若采用稳定版本安装方式，pip会自动安装项目所需的基础依赖包。若选择从源码安装并使用poetry进行依赖管理，当执行poetry install命令时，poetry会根据pyproject.toml和poetry.lock文件，自动下载并安装项目所需的所有Python依赖库。
2. 特定模型依赖：如果要使用OpenAI的模型（默认支持），需要配置OpenAI API密钥。若使用其他模型，如Anthropic模型，除了配置相应的API密钥外，还可能需要安装特定的依赖库。对于开源模型如WizardCoder，按照文档中的示例说明，可能需要额外安装一些特定的模型加载和交互相关的库。

安装

稳定版本安装

通过pip命令可以轻松安装gpt – engineer的稳定版本：

python -m pip install gpt - engineer

此方式会从Python Package Index（PyPI）下载并安装最新的稳定版本，适合那些追求稳定性，不希望使用开发版本可能存在的不稳定特性的用户。

开发版本安装

1. 克隆项目代码：首先，使用git命令克隆项目仓库到本地：

git clone https://github.com/gpt - engineer - org/gpt - engineer.git

1. 进入项目目录：克隆完成后，进入项目所在目录：

cd gpt - engineer

1. 安装依赖并激活虚拟环境：项目使用poetry进行依赖管理，执行以下命令安装项目依赖：

poetry install

安装完成后，激活poetry创建的虚拟环境：

poetry shell

通过这种方式安装开发版本，你可以获取到项目的最新代码，便于参与项目开发、测试新功能或修复已知问题。

其他安装方式

1. Docker方式：项目提供了Docker支持。在Dockerfile中，项目从python:slim基础镜像构建，并添加了git工具。使用Docker安装的好处是可以避免本地环境的依赖冲突，提供一个隔离的运行环境。构建和运行Docker镜像的具体步骤如下：
   • 构建镜像：在项目根目录下，执行docker build -t gpt - engineer.命令构建镜像，其中-t参数用于指定镜像的标签为gpt - engineer。
   • 运行容器：构建完成后，可使用docker run -it gpt - engineer命令运行容器，-it参数用于以交互模式运行容器，方便在容器内进行操作。
2. 浏览器内运行：虽然项目主要是基于终端运行，但也可以在浏览器内进行一些操作。例如，可以通过特定的在线平台（文档未详细说明具体平台），实现创建新项目、编写代码等功能。这种方式适合那些没有本地开发环境，或者希望快速体验项目功能的用户。

使用

创建新项目

1. 创建项目目录：在本地计算机的任意位置创建一个空文件夹作为项目目录。例如，在用户主目录下创建一个名为my_project的文件夹：

mkdir ~/my_project

1. 编写提示文件：在新创建的项目文件夹内，创建一个名为prompt（无文件扩展名）的文件。在这个文件中，使用自然语言描述你想要创建的软件。例如，你可以在prompt文件中写入：“创建一个简单的Python Flask应用，实现一个返回‘Hello, World!’的API端点。”
2. 运行项目生成命令：进入到gpt - engineer项目目录（如果是从源码安装），或者直接在命令行中运行已安装的gpt - engineer命令。执行以下命令：

gpte ~/my_project

这里的~/my_project是项目目录的路径。gpt - engineer会读取prompt文件中的内容，并调用相应的AI模型，生成代码并尝试在本地环境中执行。

改进现有代码

1. 定位项目目录：找到包含需要改进代码的文件夹。例如，假设已有一个名为old_project的项目文件夹，里面包含一些Python代码，你希望对其进行改进。
2. 编写改进提示文件：在old_project文件夹内创建一个prompt文件，在文件中描述对代码的改进要求。比如，“优化此Python代码中的算法，提高其执行效率”。
3. 运行改进命令：进入gpt - engineer项目目录（如果是从源码安装），执行以下命令：

gpte old_project -i

-i参数表示这是一个改进现有代码的操作。gpt - engineer会根据prompt文件中的要求，对old_project中的代码进行改进。

基准测试自定义代理

1. 安装基准测试工具：gpt - engineer安装过程中会安装名为bench的二进制文件，用于基准测试。
2. 使用模板仓库：获取基准测试模板仓库，该仓库包含详细的使用说明和代理模板。例如，可以通过git clone命令克隆模板仓库到本地。
3. 运行基准测试：按照模板仓库中的说明，配置好测试环境和自定义代理后，执行bench命令，对自定义代理进行基准测试。目前支持的基准测试数据集包括APPS和MBPP。

高级功能使用

1. 自定义预提示（Pre Prompts）：通过覆盖preprompts文件夹，可以指定AI代理的“身份”。例如，如果你希望AI在生成代码时遵循特定的代码风格或记住某些特定的业务规则，可以在preprompts文件夹中自定义预提示内容。在运行gpt - engineer时，使用--use - custom - preprompts参数指定自定义的preprompts文件夹路径。
2. 图像输入（Vision）：对于支持视觉功能的模型，gpt - engineer可以接受图像输入。例如，如果你有一个UX设计图或架构图，希望作为生成代码的额外上下文，可以使用--image_directory标志指定图像目录，并在第二个CLI参数中设置支持视觉功能的模型。例如：

gpte projects/example - vision gpt - 4 - vision - preview --prompt_file prompt/text --image_directory prompt/images - i

1. 使用开源、本地和替代模型：除了默认支持的OpenAI和Anthropic模型，通过一些额外的设置，还可以使用开源模型如WizardCoder。具体的设置步骤可参考项目文档中的示例说明，通常需要配置模型的路径、加载方式以及与模型交互的相关参数。

注意事项

API密钥安全

1. 环境变量设置：如果通过导出环境变量的方式设置OPENAI_API_KEY，如export OPENAI_API_KEY=[your api key]，确保不要在公开的脚本或配置文件中直接明文存储密钥。为了避免每次启动终端都需要重新设置，可以将该命令添加到.bashrc文件中，但要注意.bashrc文件的权限设置，确保只有当前用户可读写。
2. .env文件设置：如果使用.env文件存储OPENAI_API_KEY，同样要保证.env文件的安全性，不要将其提交到版本控制系统（如Git）中，以免密钥泄露。可以在.gitignore文件中添加.env，确保其不会被误提交。

模型使用限制

1. OpenAI模型：使用OpenAI模型时，需遵守OpenAI的使用条款和API调用限制。例如，可能存在API调用频率限制、每月使用额度限制等。如果超出这些限制，可能会导致API请求失败。在高频率使用场景下，建议提前规划好API调用策略，避免因超出限制而影响项目进度。
2. 其他模型：对于Anthropic模型或开源模型，同样需要了解其各自的使用限制和许可协议。例如，某些开源模型可能有特定的使用条件，如需要在生成的代码中保留版权声明等。

代码生成与执行风险

1. 代码安全性：由AI生成的代码可能存在安全风险，如注入漏洞、未处理的异常等。在将生成的代码应用到实际生产环境之前，务必进行全面的安全审查和测试。可以使用一些常见的代码安全扫描工具，如Bandit（用于Python代码），对生成的代码进行安全性检测。
2. 代码执行问题：由于生成的代码可能依赖于特定的运行环境和库版本，在执行代码时可能会遇到依赖冲突或版本不兼容问题。如果在运行gpt - engineer生成的代码时出现错误，首先检查项目的依赖环境是否正确配置，以及生成的代码中是否有明确的版本要求。可以通过查看项目的requirements.txt文件（如果生成了该文件）或pyproject.toml文件来了解依赖情况。

项目版本兼容性

1. Python版本：如前文所述，不同版本的gpt - engineer对Python版本有不同的支持。在升级或降级gpt - engineer版本时，要确保Python版本与项目要求兼容。否则，可能会出现运行时错误或某些功能无法正常使用的情况。
2. 依赖库版本：gpt - engineer项目依赖的库可能会随着时间更新，新的库版本可能会引入一些不兼容的变化。如果在项目使用过程中遇到问题，可以查看poetry.lock文件（如果使用poetry）或requirements.txt文件，了解当前项目所依赖的库版本，并尝试锁定版本或升级/降级到合适的版本。

官网：https://lovable.dev/

项目地址：  https://github.com/AntonOsika/gpt-engineer