gpt-engineer

环境要求

• Python 3.10 - 3.12（3.8/3.9 仅支持到 0.2.6 版本）
• OpenAI API Key（或其他自定义模型的密钥）
• Windows 用户需参考仓库中的 WINDOWS_README.md
• 开发模式安装需要 Poetry

安装与启动步骤

1. 1安装 gpt-engineer

   稳定版直接通过 pip 安装即可，建议在虚拟环境中执行，避免污染全局环境。

   python -m pip install gpt-engineer

   复制

2. 2（可选）克隆源码开发

   想改源码或用最新开发版时，克隆仓库后用 Poetry 安装依赖并激活虚拟环境。

   git clone https://github.com/gpt-engineer-org/gpt-engineer.git
   cd gpt-engineer
   poetry install
   poetry shell

   复制

3. 3配置 API Key

   在环境变量或 .env 文件中二选一填入密钥，密钥形如 sk-xxxxxxxx，切勿外泄。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

4. 4用 .env 文件配置密钥

   不想每次设置环境变量时，可把仓库里的 .env.template 复制成 .env，再把密钥填进去。

   cp .env.template .env

   复制

5. 5创建项目并写 prompt

   新建一个空文件夹，在其中创建无扩展名的 prompt 文件，用自然语言写下你的软件需求。

   mkdir -p projects/my-new-project

   复制

6. 6运行生成代码

   在 gpt-engineer 目录根下执行 gpte 加项目相对路径，AI 会读取 prompt 并编写代码。

   gpte projects/my-new-project

   复制

关键配置

如何确认成功

执行 gpte 后终端出现 AI 生成过程，且指定项目文件夹内新增了生成的代码文件即成功。

常见问题

注意事项

• API Key 属于敏感信息，不要提交到 Git 仓库或分享给他人。
• README 中的克隆地址为 gpt-engineer-org/gpt-engineer.git，与仓库展示地址可能不同，克隆前请自行确认。
• 开发模式依赖 Poetry，如未安装请先准备 Poetry 环境。
• gpte 需使用项目的相对路径，建议在 gpt-engineer 目录根下执行。