---

---

---

---

GPT Pilot 是 Pythagora VS Code 扩展 的核心技术，旨在提供 首个真正的 AI 开发者助手。它不仅仅是自动补全工具或 PR 提交信息的辅助工具，而是一位能够编写完整功能、调试代码、与你讨论问题、请求代码评审等的真正 AI 开发者。

---

📫 如果您希望获取未来版本的更新信息或与我们联系，请加入我们的 Discord 服务器，或者您也可以在此处填写您的电子邮箱地址 (http://eepurl.com/iD6Mpo)。📬

---

• 🔌 需求
• 🚦 如何开始使用 gpt-pilot？
• 🔎 示例
• 🐳 如何在 Docker 中启动 gpt-pilot？
• 🧑‍💻 CLI 参数
• 🏗 GPT Pilot 是如何工作的？
• 🕴 GPT Pilot 与 Smol developer 和 GPT engineer 有何不同？
• 🍻 贡献
• 🔗 与我们联系
• 🌟 星标历史

---

GPT Pilot 的目标是研究大型语言模型在多大程度上可以用于生成完全可用、可投入生产的应用程序，同时由开发者负责监督实施过程。

核心理念是：AI 可以编写应用程序的大部分代码（或许高达 95%），但剩下的 5% 仍需要开发者来完成——在我们实现通用人工智能之前，这一点将一直如此。

如果您对我们在此项目中的学习成果感兴趣，可以查看 我们的最新博客文章。

---

---

🔌 需求

• Python 3.9+

🚦如何开始使用 gpt-pilot？

👉 如果您使用 VS Code 作为 IDE，最简单的方式是下载 GPT Pilot VS Code 扩展。👈

否则，您可以使用命令行工具。

如果您是 GPT Pilot 的新用户：

在安装好 Python 和（可选）PostgreSQL 后，请按照以下步骤操作：

1. git clone https://github.com/Pythagora-io/gpt-pilot.git（克隆仓库）
2. cd gpt-pilot（进入仓库目录）
3. python3 -m venv venv（创建虚拟环境）
4. source venv/bin/activate（或在 Windows 上运行 venv\Scripts\activate）（激活虚拟环境）
5. pip install -r requirements.txt（安装依赖项）
6. cp example-config.json config.json（创建 config.json 文件）
7. 在 config.json 文件中设置您的密钥及其他配置：
   • LLM 提供商（openai、anthropic 或 groq）的密钥和端点（默认值为 null）（请注意，Azure 和 OpenRouter 可通过 openai 设置支持）
   • 您的 API 密钥（如果为 null，则会从环境变量中读取）
   • 数据库设置：默认使用 SQLite，PostgreSQL 也应能正常工作
   • 您还可以选择更新 fs.ignore_paths，添加不应被 GPT Pilot 追踪的文件或文件夹，例如编译器生成的文件夹
8. python main.py（启动 GPT Pilot）

所有生成的代码都将存储在名为“workspace”的文件夹中，该文件夹以您启动 pilot 时输入的应用程序名称命名。

🔎 示例

点击此处 查看所有由 GPT Pilot 创建的应用示例。

PostgreSQL 支持

GPT Pilot 默认使用内置的 SQLite 数据库。如果您想使用 PostgreSQL 数据库，需要额外安装 asyncpg 和 psycopg2 包：

pip install asyncpg psycopg2

然后，您需要更新 config.json 文件，将 db.url 设置为 postgresql+asyncpg://<user>:<password>@<db-host>/<db-name>。

🧑‍💻️ CLI 参数

列出已创建的项目（应用）

python main.py --list

注意：对于每个项目（应用），此命令也会列出“分支”。目前我们只支持一个分支（称为“main”），未来计划增加对多个项目分支的支持。

加载并从项目的最新步骤继续

python main.py --project <app_id>

加载并从项目的特定步骤继续

python main.py --project <app_id> --step <step>

警告：这将删除指定步骤之后的所有进度！

删除项目（应用）

python main.py --delete <app_id>

删除具有指定 app_id 的项目。警告：此操作不可撤销！

其他命令行选项

还有一些其他命令行选项，主要用于支持从我们的 VSCode 插件调用 GPT Pilot。要查看所有可用选项，请使用 --help 标志：

python main.py --help

🏗 GPT Pilot 是如何工作的？

以下是 GPT Pilot 创建应用程序的步骤：

1. 您输入应用名称和描述。
2. 产品负责人代理 就像现实生活中一样，什么都不做。:)
3. 如果项目描述不够清晰，需求撰写者代理 会提出几个问题，以便更好地理解需求。
4. 架构师代理 拟定应用将使用的技术栈，并检查这些技术是否已安装在本地机器上；若未安装，则进行安装。
5. 技术负责人代理 列出开发者需要实现的开发任务。
6. 开发者代理 针对每项任务，以人类可读的形式详细说明实现该任务所需的步骤。
7. 代码猿代理 根据开发者的描述和现有文件，完成代码修改。
8. 评审员代理 对任务的每一步进行审查；若发现错误，会将其退回给代码猿代理。
9. 故障排除员代理 在出现问题时，帮助您向 GPT Pilot 提供有效的反馈。
10. 调试器代理 虽然大家都不太想见到他，但当事情不顺时，他却是您的最佳伙伴。
11. 技术文档编写员代理 为项目编写文档。

🕴 GPT Pilot 与 Smol developer 和 GPT engineer 有何不同？

• GPT Pilot 与开发者协作，共同构建一个完全可用且可投入生产的应用。我认为目前（至少在短期内）AI 还无法在没有开发者参与的情况下独立创建应用。因此，GPT Pilot 会像真实开发者一样，逐步编写代码，并在开发过程中及时调试遇到的问题。如果遇到卡壳的情况，作为负责人的您可以直接查看代码并修复问题。而其他类似工具通常会一次性生成整个代码库，这样一来，无论是 AI 还是开发者，都很难定位和修复其中的 bug。
  
  
• 支持规模化开发：GPT Pilot 并非仅用于创建简单应用，而是旨在适应任何规模的项目。它内置了代码筛选机制，因此在每次与大语言模型的对话中，无需将整个代码库都纳入上下文，而是只向 LLM 展示当前任务相关的代码片段。当应用开发完成后，您可以通过提供新增功能的指令继续推进项目。

🍻 贡献

如果您有兴趣为 GPT Pilot 做贡献，请加入我们的 Discord 社区，浏览公开的 GitHub 问题，看看是否有您感兴趣的议题。我们非常欢迎您协助解决这些问题。建议您先阅读上述博客文章，了解其架构设计，再深入代码库。

🖥 开发工作

除了研究之外，GPT Pilot 还需要在各种场景下进行调试和优化。例如，我们发现生成代码的质量对开发任务的粒度非常敏感：当任务过于宽泛时，生成的代码往往包含大量难以修复的 bug；而当任务过于细化时，GPT 又似乎难以将新内容融入现有代码中。

📊 数据监控

为了持续改进 GPT Pilot，我们正在收集部分事件数据，您可随时选择退出数据收集。更多详情请参阅 这里。

🔗 与我们联系

🌟 作为一款开源工具，如果您能为 GPT-Pilot 仓库点个赞，对我们来说将是莫大的鼓励 🌟

💬 欢迎加入 Discord 社区，与我们互动交流。

GPT Pilot 快速上手指南

⚠️ 重要提示：根据官方 README，该仓库（gpt-pilot）已停止维护。核心功能已迁移至 Pythagora VS Code 插件。如果您希望获得更稳定的 AI 开发体验，建议直接使用 VS Code 插件。以下内容仅针对希望研究源码或使用 CLI 版本的开发者。

GPT Pilot 旨在成为真正的 AI 开发伙伴，它不仅能生成代码，还能通过多智能体协作（产品负责人、架构师、技术主管、开发者、审查员等）逐步构建完整的生产级应用。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Windows, macOS 或 Linux
• Python 版本：Python 3.9 或更高版本
• 数据库（可选）：默认使用内置 SQLite。若需使用 PostgreSQL，需额外安装数据库服务。
• API Key：需要准备 LLM 提供商的 API Key（支持 OpenAI, Anthropic, Groq 等）。

安装步骤

1. 克隆项目

打开终端，执行以下命令获取源码：

git clone https://github.com/Pythagora-io/gpt-pilot.git
cd gpt-pilot

2. 创建并激活虚拟环境

建议使用虚拟环境以避免依赖冲突：

python3 -m venv venv

激活环境：

• macOS / Linux:

  source venv/bin/activate
  

• Windows:

  venv\Scripts\activate
  

3. 安装依赖

安装项目所需的 Python 包：

pip install -r requirements.txt

(可选) 如果您计划使用 PostgreSQL 代替默认的 SQLite，请额外安装：

pip install asyncpg psycopg2

4. 配置项目

复制示例配置文件并编辑：

cp example-config.json config.json

使用文本编辑器打开 config.json，配置以下关键信息：

• LLM Provider: 设置提供商（如 openai, anthropic, groq）。
• API Key: 填入您的 API Key（若留空 null，将从环境变量读取）。
• Database: 默认使用 sqlite，如需更改可在此处配置连接字符串。
• Ignore Paths: 可在 fs.ignore_paths 中添加需要忽略的文件夹（如编译生成的目录）。

基本使用

配置完成后，即可启动 GPT Pilot 开始构建应用。

启动应用

在终端运行：

python main.py

操作流程

1. 输入应用信息：程序启动后，根据提示输入应用名称和功能描述。
2. 智能体协作：GPT Pilot 将自动调用多个智能体（规格撰写者、架构师、技术主管、开发者、代码猴子、审查员等）逐步完成任务：
   • 明确需求与技术栈。
   • 检查并安装所需环境。
   • 拆解开发任务并编写代码。
   • 自动审查与调试。
3. 查看结果：所有生成的代码将保存在 workspace/<应用名称> 目录下。

常用命令行参数

• 列出已有项目：

  python main.py --list
  

• 继续开发指定项目：

  python main.py --project <app_id>
  

• 从特定步骤继续（注意：这将删除该步骤之后的所有进度）：

  python main.py --project <app_id> --step <step>
  

• 删除项目：

  python main.py --delete <app_id>
  

• 查看所有帮助选项：

  python main.py --help
  

---

更多由 GPT Pilot 生成的应用案例，请访问官方 Wiki 查看。