gpt-engineer README

The project's README from github.com/AntonOsika/gpt-engineer. As one markdown file: README.md.

gpt-engineer

GitHub Repo stars Discord Follow License GitHub Issues or Pull Requests GitHub Release Twitter Follow

The OG code genereation experimentation platform!

If you are looking for the evolution that is an opinionated, managed service – check out gptengineer.app.

If you are looking for a well maintained hackable CLI for – check out aider.

gpt-engineer lets you:

Getting Started

Install gpt-engineer

For stable release:

For development:

We actively support Python 3.10 - 3.12. The last version to support Python 3.8 - 3.9 was 0.2.6.

Setup API key

Choose one of:

Check the Windows README for Windows usage.

Other ways to run:

Create new code (default usage)

Improve existing code

Benchmark custom agents

The community has started work with different benchmarking initiatives, as described in this Loom video.

Research

Some of our community members have worked on different research briefs that could be taken further. See this document if you are interested.

Terms

By running gpt-engineer, you agree to our terms.

Relation to gptengineer.app (GPT Engineer)

gptengineer.app is a commercial project for the automatic generation of web apps. It features a UI for non-technical users connected to a git-controlled codebase. The gptengineer.app team is actively supporting the open source community.

Features

Pre Prompts

You can specify the "identity" of the AI agent by overriding the preprompts folder with your own version of the preprompts. You can do so via the --use-custom-preprompts argument.

Editing the preprompts is how you make the agent remember things between projects.

Vision

By default, gpt-engineer expects text input via a prompt file. It can also accept image inputs for vision-capable models. This can be useful for adding UX or architecture diagrams as additional context for GPT Engineer. You can do this by specifying an image directory with the —-image_directory flag and setting a vision-capable model in the second CLI argument.

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

Open source, local and alternative models

By default, gpt-engineer supports OpenAI Models via the OpenAI API or Azure OpenAI API, as well as Anthropic models.

With a little extra setup, you can also run with open source models like WizardCoder. See the documentation for example instructions.

Mission

The gpt-engineer community mission is to maintain tools that coding agent builders can use and facilitate collaboration in the open source community.

If you are interested in contributing to this, we are interested in having you.

If you want to see our broader ambitions, check out the roadmap, and join discord to learn how you can contribute to it.

gpt-engineer is governed by a board of long-term contributors. If you contribute routinely and have an interest in shaping the future of gpt-engineer, you will be considered for the board.

Significant contributors

Example

https://github.com/gpt-engineer-org/gpt-engineer/assets/4467025/40d0a9a8-82d0-4432-9376-136df0d57c99

gpt-engineer (AntonOsika/gpt-engineer)

Searching Database…

55K ·GitHub
Gpt-engineer
archived
这是什么？gpt-engineer 是一个命令行工具。你只需在一个纯文本的 'prompt' 文件中描述想要的软件，AI（OpenAI、Azure OpenAI 或 Anthropic 的模型）就会为你编写并运行代码；你也可以让它对现有代码进行改进。
这是可以导入的库，还是独立的命令行工具？它是一个独立的命令行工具，可以通过 pip 安装（或用 Docker 运行），对项目文件夹执行 'gpte' 命令来使用，而不是可以导入到你自己代码中的库。
我该怎么让它运行起来？用 'python -m pip install gpt-engineer' 安装，创建一个空的项目文件夹，添加一个名为 'prompt' 的文件并写入你的指令，然后运行 'gpte projects/my-new-project' 并指向该文件夹。
使用它必须要有 OpenAI API 密钥吗？默认需要：可以通过 export OPENAI_API_KEY 设置，也可以把它放在 .env 文件中；它同样支持 Azure OpenAI、Anthropic 模型，以及 WizardCoder 等本地或开源模型，但需要多做一些额外设置。
这个项目还在积极维护吗？已经不再维护了，该仓库已归档。README 本身也建议用户转向 gptengineer.app（托管的后续产品），或者改用 'aider'，它是一个维护良好、可自由修改的命令行替代工具。
它在 Windows 上也能用吗，还是只能在 macOS/Linux 上用？可以。项目有专门的 Windows README，介绍 Windows 特有的用法；除了标准的 pip 安装方式外，还提供 Docker 选项。
如何改进现有代码，而不是新建一个项目？让 gpt-engineer 指向一个已经包含代码的文件夹，添加一个 'prompt' 文件描述想要的修改，然后运行 'gpte path/to/folder -i'，即可应用 AI 驱动的改进。
我能用它来测试自己的编程智能体吗？可以。安装 gpt-engineer 时也会一并安装一个 'bench' 命令行工具，用于在 APPS、MBPP 等公开数据集上测试自定义的智能体实现。
它支持为视觉模型输入图片吗？支持。你可以用 --image_directory 参数传入一个图片目录，并搭配 gpt-4-vision-preview 等支持视觉的模型使用，适合把 UX 设计图或架构图作为上下文提供给 AI。
它和 gptengineer.app 有什么区别？gptengineer.app 是商业化的升级版，仍在积极开发，提供面向非技术用户的界面，并通过 git 管理代码库；而本仓库是最初的开源命令行实验工具，现已归档。
What are similar projects?gpt-pilot, plandex, self-operating-computer, Baize, aider, reverse-api-engineer, trae-agent, Agent-S
Which topics is it in?codegen, autonomous-agent, coding-assistant, benchmarking, gpt-4, openai-api, vibe-coding, azure, code-generation, deprecated, anthropic, benchmark
Creator
AntonOsika
Size
20 MB
Stars
55K
Updated
CommitNov 17Releasev0.3.1Jun 06
Age
3y
Commits · 90 Days