Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Pythagora-io/gpt-pilot

The first real AI developer
https://github.com/Pythagora-io/gpt-pilot

ai codegen coding-assistant developer-tools gpt-4 research-project

Last synced: about 1 month ago
JSON representation

The first real AI developer

Lists

README 

        



# 🧑‍✈️ GPT PILOT 🧑‍✈️






---






[![Discord Follow](https://dcbadge.vercel.app/api/server/HaqXugmxr9?style=flat)](https://discord.gg/HaqXugmxr9)

[![GitHub Repo stars](https://img.shields.io/github/stars/Pythagora-io/gpt-pilot?style=social)](https://github.com/Pythagora-io/gpt-pilot)

[![Twitter Follow](https://img.shields.io/twitter/follow/HiPythagora?style=social)](https://twitter.com/HiPythagora)






---





Pythagora-io%2Fgpt-pilot | Trendshift








Pythagora-io%2Fgpt-pilot | Trendshift














### GPT Pilot doesn't just generate code, it builds apps!






---




[![See it in action](https://i3.ytimg.com/vi/4g-1cPGK0GA/maxresdefault.jpg)](https://youtu.be/4g-1cPGK0GA)



(click to open the video in YouTube) (1:40min)






---






Pythagora-io%2Fgpt-pilot | Trendshift






GPT Pilot is the core technology for the [Pythagora VS Code extension](https://bit.ly/3IeZxp6) that aims to provide **the first real AI developer companion**. Not just an autocomplete or a helper for PR messages but rather a real AI developer that can write full features, debug them, talk to you about issues, ask for review, etc.



---



📫 If you would like to get updates on future releases or just get in touch, join our [Discord server](https://discord.gg/HaqXugmxr9) or you [can add your email here](http://eepurl.com/iD6Mpo). 📬



---



* [🔌 Requirements](#-requirements)

* [🚦How to start using gpt-pilot?](#how-to-start-using-gpt-pilot)

* [🔎 Examples](#-examples)

* [🐳 How to start gpt-pilot in docker?](#-how-to-start-gpt-pilot-in-docker)

* [🧑‍💻️ CLI arguments](#-cli-arguments)

* [🏗 How GPT Pilot works?](#-how-gpt-pilot-works)

* [🕴How's GPT Pilot different from _Smol developer_ and _GPT engineer_?](#hows-gpt-pilot-different-from-smol-developer-and-gpt-engineer)

* [🍻 Contributing](#-contributing)

* [🔗 Connect with us](#-connect-with-us)

* [🌟 Star history](#-star-history)



---



GPT Pilot aims to research how much LLMs can be utilized to generate fully working, production-ready apps while the developer oversees the implementation.



**The main idea is that AI can write most of the code for an app (maybe 95%), but for the rest, 5%, a developer is and will be needed until we get full AGI**.



If you are interested in our learnings during this project, you can check [our latest blog posts](https://blog.pythagora.ai/2024/02/19/gpt-pilot-what-did-we-learn-in-6-months-of-working-on-a-codegen-pair-programmer/).



---










### **[👉 Examples of apps written by GPT Pilot 👈](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot)**









---



# 🔌 Requirements



- **Python 3.9+**



# 🚦How to start using gpt-pilot?

👉 If you are using VS Code as your IDE, the easiest way to start is by downloading [GPT Pilot VS Code extension](https://bit.ly/3IeZxp6). 👈



Otherwise, you can use the CLI tool.



After you have Python and (optionally) PostgreSQL installed, follow these steps:

1. `git clone https://github.com/Pythagora-io/gpt-pilot.git` (clone the repo)

2. `cd gpt-pilot`

3. `python -m venv pilot-env` (create a virtual environment)

4. `source pilot-env/bin/activate` (or on Windows `pilot-env\Scripts\activate`) (activate the virtual environment)

5. `pip install -r requirements.txt` (install the dependencies)

6. `cd pilot`

7. `mv .env.example .env` (or on Windows `copy .env.example .env`) (create the .env file)

8. Add your environment to the `.env` file:

   - LLM Provider (OpenAI/Azure/Openrouter)

   - Your API key

   - database settings: SQLite/PostgreSQL (to change from SQLite to PostgreSQL, just set `DATABASE_TYPE=postgres`)

   - optionally set IGNORE_PATHS for the folders which shouldn't be tracked by GPT Pilot in workspace, useful to ignore folders created by compilers (i.e. `IGNORE_PATHS=folder1,folder2,folder3`)

9. `python main.py` (start GPT Pilot)



After, this, you can just follow the instructions in the terminal.



All generated code will be stored in the folder `workspace` inside the folder named after the app name you enter upon starting the pilot.



# 🔎 [Examples](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot)



[Click here](https://github.com/Pythagora-io/gpt-pilot/wiki/Apps-created-with-GPT-Pilot) to see all example apps created with GPT Pilot.



## 🐳 How to start gpt-pilot in docker?

1. `git clone https://github.com/Pythagora-io/gpt-pilot.git` (clone the repo)

2. Update the `docker-compose.yml` environment variables, which can be done via `docker compose config`. If you wish to use a local model, please go to [https://localai.io/basics/getting_started/](https://localai.io/basics/getting_started/).

3. By default, GPT Pilot will read & write to `~/gpt-pilot-workspace` on your machine, you can also edit this in `docker-compose.yml`

4. run `docker compose build`. this will build a gpt-pilot container for you.

5. run `docker compose up`.

6. access the web terminal on `port 7681`

7. `python main.py` (start GPT Pilot)



This will start two containers, one being a new image built by the `Dockerfile` and a Postgres database. The new image also has [ttyd](https://github.com/tsl0922/ttyd) installed so that you can easily interact with gpt-pilot. Node is also installed on the image and port 3000 is exposed.



# 🧑‍💻️ CLI arguments



## `--get-created-apps-with-steps`

Lists all existing apps.



```bash

python main.py --get-created-apps-with-steps

```







## `app_id`

Continue working on an existing app using **`app_id`**

```bash

python main.py app_id=

```







## `step`

Continue working on an existing app from a specific **`step`** (eg: `development_planning`)

```bash

python main.py app_id= step=

```







## `skip_until_dev_step`

Continue working on an existing app from a specific **development step**

```bash

python main.py app_id= skip_until_dev_step=

```

Continue working on an existing app from a specific **`development step`**. If you want to play around with GPT Pilot, this is likely the flag you will often use.







```bash

python main.py app_id= skip_until_dev_step=0

```

Erase all development steps previously done and continue working on an existing app from the start of development.



## `theme`

```bash

python main.py theme=light

```

```bash

python main.py theme=dark

```







# 🏗 How GPT Pilot works?

Here are the steps GPT Pilot takes to create an app:



1. You enter the app name and the description.

2. **Product Owner agent** like in real life, does nothing. :)

3. **Specification Writer agent** asks a couple of questions to understand the requirements better if project description is not good enough.

4. **Architect agent** writes up technologies that will be used for the app and checks if all technologies are installed on the machine and installs them if not.

5. **Tech Lead agent** writes up development tasks that the Developer must implement.

6. **Developer agent** takes each task and writes up what needs to be done to implement it. The description is in human-readable form.

7. **Code Monkey agent** takes the Developer's description and the existing file and implements the changes.

8. **Reviewer agent** reviews every step of the task and if something is done wrong Reviewer sends it back to Code Monkey.

9. **Troubleshooter agent** helps you to give good feedback to GPT Pilot when something is wrong.

10. **Debugger agent** hate to see him, but he is your best friend when things go south.

11. **Technical Writer agent** writes documentation for the project.







# 🕴How's GPT Pilot different from _Smol developer_ and _GPT engineer_?



- **GPT Pilot works with the developer to create a fully working production-ready app** - I don't think AI can (at least in the near future) create apps without a developer being involved. So, **GPT Pilot codes the app step by step** just like a developer would in real life. This way, it can debug issues as they arise throughout the development process. If it gets stuck, you, the developer in charge, can review the code and fix the issue. Other similar tools give you the entire codebase at once - this way, bugs are much harder to fix for AI and for you as a developer.

  



- **Works at scale** - GPT Pilot isn't meant to create simple apps but rather so it can work at any scale. It has mechanisms that filter out the code, so in each LLM conversation, it doesn't need to store the entire codebase in context, but it shows the LLM only the relevant code for the current task it's working on. Once an app is finished, you can continue working on it by writing instructions on what feature you want to add.



# 🍻 Contributing

If you are interested in contributing to GPT Pilot, join [our Discord server](https://discord.gg/HaqXugmxr9), check out open [GitHub issues](https://github.com/Pythagora-io/gpt-pilot/issues), and see if anything interests you. We would be happy to get help in resolving any of those. The best place to start is by reviewing blog posts mentioned above to understand how the architecture works before diving into the codebase.



## 🖥 Development

Other than the research, GPT Pilot needs to be debugged to work in different scenarios. For example, we realized that the quality of the code generated is very sensitive to the size of the development task. When the task is too broad, the code has too many bugs that are hard to fix, but when the development task is too narrow, GPT also seems to struggle in getting the task implemented into the existing code.



## 📊 Telemetry

To improve GPT Pilot, we are tracking some events from which you can opt out at any time. You can read more about it [here](./docs/TELEMETRY.md).



# 🔗 Connect with us

🌟 As an open-source tool, it would mean the world to us if you starred the GPT-pilot repo 🌟



💬 Join [the Discord server](https://discord.gg/HaqXugmxr9) to get in touch.