基本用法

概述

gpt-engineer 的基本工作流程允许您

用自然语言指定您的软件需求
让 AI 为您编写代码
执行和测试生成的代码

该流程设计得简单易用，同时让您完全掌控要构建的内容。

来源：README.md56-66 gpt_engineer/applications/cli/main.py269-558

设置要求

在使用 gpt-engineer 之前，您需要

OpenAI API 密钥：您可以通过以下两种方式之一进行设置
- 设置为环境变量：export OPENAI_API_KEY=[your api key]
- 在您的项目目录中创建一个名为 .env 的文件，其中包含 OPENAI_API_KEY=[your api key]
项目目录：创建一个空文件夹，您的项目将在其中生成

来源：README.md38-47

编写提示

提示是决定 gpt-engineer 将构建什么的关键输入。在您的项目目录中创建一个名为 prompt 的文件（不带文件扩展名）

有效的提示技巧

具体说明您想要的功能
提及首选技术、框架或模式
包含任何限制或要求
指定期望的项目结构

来源：README.md58-59 gpt_engineer/applications/cli/main.py105-170

生成代码

要生成代码，请使用项目目录的路径运行 gpte 命令

这将触发以下过程

来源：gpt_engineer/applications/cli/cli_agent.py152-183 gpt_engineer/core/default/steps.py121-268

代码生成组件

当您运行 gpte 时，这些关键组件会协同工作

来源：gpt_engineer/applications/cli/cli_agent.py36-101 gpt_engineer/core/default/disk_execution_env.py36-111 gpt_engineer/core/default/disk_memory.py36-327

执行流程

代码生成后，gpt-engineer

创建一个 run.sh 入口点脚本
请求您的许可来执行它
如果您批准，则运行该脚本

该 run.sh 脚本通常会

设置环境（例如，创建虚拟环境）
安装依赖项
运行应用程序

来源：gpt_engineer/core/default/steps.py205-268

命令行选项

基本的 gpte 命令支持各种选项

选项	描述
`-m`, `--model`	指定模型（默认：gpt-4o）
`-t`, `--temperature`	控制随机性（0.1-1.0，默认：0.1）
`--lite`, `-l`	使用精简模式（更简单的生成）
`--clarify`, `-c`	在编码前讨论需求
`--prompt_file`	指定不同的提示文件
`--no_execution`	跳过代码执行
`--verbose`, `-v`	启用详细日志记录

带选项的示例

来源：gpt_engineer/applications/cli/main.py271-380

高级生成模式

gpt-engineer 提供专门的生成模式

精简模式

通过简化的流程生成代码

这使用了 lite_gen() 函数，它执行更简化的生成，步骤更少。

澄清模式

允许您在代码生成前讨论和完善需求

当您使用此模式时

AI 会就您的需求提出澄清性问题
您回答这些问题以完善规范
AI 根据您澄清的需求生成代码

这对于初始需求可能不明确的复杂项目很有用。

来源：gpt_engineer/tools/custom_steps.py122-195 gpt_engineer/tools/custom_steps.py198-233

自愈模式

用于实验性的自动 bug 修复

此模式

生成代码
自动尝试执行它
如果执行失败，将错误信息发送回 AI
AI 尝试修复代码
重复直到执行成功或达到最大尝试次数

来源：gpt_engineer/tools/custom_steps.py40-119

生成后的项目结构

运行 gpte 后，您的项目目录将包含

my-project/
├── prompt                    # Your original requirements
├── run.sh                    # Entrypoint script
├── [generated source files]  # Your application code
├── .gpte/                    # Internal gpt-engineer data
│   ├── logs/                 # Logs of interactions with AI
│   │   ├── code_gen_log.txt  # Full code generation log
│   │   ├── entrypoint_log.txt # Entrypoint generation log
│   │   └── debug_log.txt     # Debugging information

.gpte 目录包含详细日志，这些日志对于故障排除或了解 AI 如何生成您的代码非常有用。

来源：gpt_engineer/core/default/disk_memory.py36-327 gpt_engineer/core/default/paths.py

示例工作流

这是一个创建简单网页计数器应用程序的完整示例

创建项目目录
创建您的提示文件
运行 gpt-engineer
审查生成的代码并在提示时批准执行
通过访问终端中提供的 URL 来测试应用程序