安装指南

相关源文件

• .env.template
• .github/CODE_OF_CONDUCT.md
• .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
• .github/workflows/ci.yaml
• .github/workflows/pre-commit.yaml
• .gitignore
• MANIFEST.in
• Makefile
• README.md
• docs/installation.rst
• poetry.lock
• pyproject.toml
• tests/applications/cli/test_learning.py
• tests/core/default/test_simple_agent.py
• tests/mock_ai.py
• tests/test_install.py
• tox.ini

目的与范围

本指南提供了在不同环境中安装和配置 gpt-engineer 的详细说明。它涵盖了安装方法、安装后设置和故障排除步骤。有关安装 gpt-engineer 后的使用信息，请参阅 用户指南。

来源： README.md22-65 docs/installation.rst1-21

系统要求

Python 版本兼容性

gpt-engineer 目前支持 Python 3.10 到 3.12 版本。如果您需要兼容 Python 3.8 或 3.9，则应使用 0.2.6 或更早的版本。

来源： README.md36 pyproject.toml21 .github/workflows/ci.yaml21-22

操作系统兼容性

gpt-engineer 兼容大多数操作系统

• Linux
• macOS
• Windows（请参阅 Windows 使用的特别说明）

来源： README.md49

安装方法

本节详细介绍了安装 gpt-engineer 的所有可用方法，并附有展示完整安装流程的工作流程图。

来源： README.md22-65 pyproject.toml66-70

方法 1：通过 pip 安装（稳定版）

安装稳定版的最简单方法是使用 pip

此方法将从 PyPI 安装最新的稳定版本，使 gpte、ge 和 gpt-engineer 命令在您的环境中可用。

来源： README.md26-28 pyproject.toml66-70

方法 2：从源代码安装（开发版）

安装具有最新功能的开发版本

1. 克隆仓库

2. 切换到存储库目录

3. 使用 Poetry 进行安装

4. 激活虚拟环境

您还可以使用提供的 Makefile 来简化安装

来源： README.md30-34 Makefile29-34

方法 3：使用 Docker

对于基于 Docker 的安装

1. 请参阅 docker/README.md 文件中的 Docker 安装说明。

来源： README.md52

方法 4：使用 GitHub Codespaces

您也可以使用 GitHub Codespaces 在浏览器中直接运行 gpt-engineer

1. 单击存储库中的“在 GitHub Codespaces 中打开”按钮。

来源： README.md53-54

安装后设置

API 密钥配置

安装 gpt-engineer 后，您需要设置 API 密钥以访问语言模型服务。

选择以下一种方法来配置您的 API 密钥

选项 1：使用环境变量

将 API 密钥导出为环境变量

在 Windows 上，使用

您可以将其添加到 .bashrc、.zshrc 或等效的 shell 配置文件中，使其持久化。

来源： README.md41-42 .env.template1-6

选项 2：创建 .env 文件

1. 创建 `.env.template` 文件的副本，并将其命名为 `.env`，放在根目录下
2. 编辑 `.env` 文件并添加您的 API 密钥

OPENAI_API_KEY=your_api_key_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here

来源： README.md43-45 .env.template1-6

选项 3：使用自定义模型

对于本地模型、Azure OpenAI 或其他提供商，请参阅文档。

来源： README.md46-47

代码架构与集成

下图说明了安装组件如何与 gpt-engineer 代码架构集成

来源： pyproject.toml21-40 pyproject.toml66-70

验证安装

安装并配置 gpt-engineer 后，您应该验证其是否正常工作。

测试基本功能

运行以下命令以检查 gpt-engineer 是否已正确安装

这应该会显示帮助信息和可用的命令。

来源： tests/test_install.py52-69 tests/test_install.py72-85

创建一个简单的项目

测试全部功能

1. 为测试项目创建一个新目录

2. 创建一个提示文件

3. 运行 gpt-engineer

如果一切设置正确，gpt-engineer 应该会在 test-project 目录中生成一个简单的 hello world 程序。

来源： README.md57-61 tests/test_install.py88-107

安装工作流程与依赖关系

下图显示了包括依赖关系和组件关系的详细安装工作流程

来源： pyproject.toml21-40 README.md22-65

故障排除

常见安装问题

问题：Python 版本不兼容

错误：gpt-engineer 要求 Python >=3.10, <3.13

解决方案：安装兼容的 Python 版本（3.10、3.11 或 3.12）。

来源：pyproject.toml21 .github/workflows/ci.yaml21

问题：缺少 tkinter

在某些 Linux 和 macOS 系统上，tkinter（它是标准的库依赖）可能未包含在精简版 Python 安装中。

对于 macOS，请使用 brew 安装 tkinter

对于基于 Debian 的 Linux 系统

来源：docs/installation.rst52-67

问题：Poetry 安装问题

如果您在使用 Poetry 时遇到问题

1. 确保您已正确安装 Poetry

2. 确保 Poetry 在您的 PATH 中。

3. 尝试更新 Poetry

来源：Makefile29-34 tests/test_install.py19-49

问题：API 密钥配置

如果 gpt-engineer 找不到您的 API 密钥

1. 验证 API 密钥是否设置正确

2. 检查 .env 文件是否位于正确的位置且格式正确。

3. 设置环境变量后，重新启动您的终端或命令提示符。

来源：README.md38-47 .env.template1-6 tests/applications/cli/test_learning.py41-53

CI/CD集成

该项目使用 GitHub Actions 进行持续集成，该集成会测试多个 Python 版本的安装情况。

来源：.github/workflows/ci.yaml1-50 tox.ini1-14

本安装指南已为您提供安装和配置 gpt-engineer 以适应您的环境所需的所有信息。如果您遇到此处未涵盖的任何问题，请参阅官方文档或在 GitHub 存储库上提交问题。