Skip to content

Commit 47dcbe2

Browse files
committed
update Readme
1 parent 3dcb9d8 commit 47dcbe2

File tree

1 file changed

+18
-45
lines changed

1 file changed

+18
-45
lines changed

README.md

+18-45
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ GPT Pilot is the core technology for the [VS Code extension](https://marketplace
1313

1414
---
1515

16-
📫 If you would like to get updates on future releases or just get in touch, you [can add your email here](http://eepurl.com/iD6Mpo). 📬
16+
📫 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). 📬
1717

1818
---
1919

@@ -40,13 +40,7 @@ GPT Pilot aims to research how much GPT-4 can be utilized to generate fully work
4040

4141
**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**.
4242

43-
I've broken down the idea behind GPT Pilot and how it works in the following blog posts:
44-
45-
**[[Part 1/3] High-level concepts + GPT Pilot workflow until the coding part](https://blog.pythagora.ai/2023/08/23/430/)**
46-
47-
**_[[Part 2/3] GPT Pilot coding workflow](https://blog.pythagora.ai/2023/09/04/gpt-pilot-coding-workflow-part-2-3/)_**
48-
49-
**_[Part 3/3] Other important concepts and future plans (COMING UP)_**
43+
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/).
5044

5145
---
5246

@@ -109,13 +103,13 @@ This will start two containers, one being a new image built by the `Dockerfile`
109103

110104
# 🧑‍💻️ CLI arguments
111105

112-
## `app_type` and `name`
113-
If not provided, the ProductOwner will ask for these values:
114106

115-
`app_type` is used as a hint to the LLM as to what kind of architecture, language options and conventions would apply. If not provided, `prompts.prompts.ask_for_app_type()` will ask for it.
116-
117-
See `const.common.APP_TYPES`: 'Web App', 'Script', 'Mobile App', 'Chrome Extension'
107+
## `--get-created-apps-with-steps`
108+
Lists all existing apps.
118109

110+
```bash
111+
python main.py --get-created-apps-with-steps
112+
```
119113

120114
## `app_id` and `workspace`
121115
Continue working on an existing app using **`app_id`**
@@ -132,22 +126,8 @@ python main.py workspace=<PATH_TO_PROJECT_WORKSPACE>
132126
Each user can have their own workspace path for each App.
133127

134128

135-
## `user_id`, `email`, and `password`
136-
These values will be saved to the User table in the DB.
137-
138-
```bash
139-
python main.py user_id=me_at_work
140-
```
141-
142-
If not specified, `user_id` defaults to the OS username but can be provided explicitly if your OS username differs from your GitHub or work username. This value is used to load the `App` config when the `workspace` arg is provided.
143-
144-
If not specified `email` will be parsed from `~/.gitconfig` if the file exists.
145-
146-
See also [What's the purpose of arguments.password / User.password?](https://github.com/Pythagora-io/gpt-pilot/discussions/55)
147-
148-
149129
## `step`
150-
Continue working on an existing app from a specific **`step`** (eg: `user_tasks`)
130+
Continue working on an existing app from a specific **`step`** (eg: `development_planning`)
151131
```bash
152132
python main.py app_id=<ID_OF_THE_APP> step=<STEP_FROM_CONST_COMMON>
153133
```
@@ -179,14 +159,6 @@ python main.py theme=dark
179159
- Dark mode.
180160
![屏幕截图 2023-10-15 104120](https://github.com/Pythagora-io/gpt-pilot/assets/138990495/942cd1c9-b774-498e-b72a-677b01be1ac3)
181161

182-
183-
## `delete_unrelated_steps`
184-
185-
186-
## `update_files_before_start`
187-
188-
189-
190162
# 🔎 Examples
191163
### Backend system for billing, admin, and user management
192164
- 💬 [Full initial prompt + additional features prompts](https://github.com/Pythagora-io/credit-based-backend-gpt-pilot-example/tree/main/prompts)
@@ -232,15 +204,16 @@ Here are the steps GPT Pilot takes to create an app:
232204
![GPT Pilot workflow](https://github.com/Pythagora-io/gpt-pilot/assets/10895136/d89ba1d4-1208-4b7f-b3d4-76e3ccea584e)
233205

234206
1. You enter the app name and the description.
235-
2. **Product Owner agent** asks a couple of questions to understand the requirements better.
236-
3. **Product Owner agent** writes user stories and asks you if they are all correct (this helps it create code later on).
237-
4. **Architect agent** writes up technologies that will be used for the app.
238-
5. **DevOps agent** checks if all technologies are installed on the machine and installs them if not.
239-
6. **Tech Lead agent** writes up development tasks that the Developer must implement. This is an important part because, for each step, the Tech Lead needs to specify how the user (real-world developer) can review if the task is done (e.g. open localhost:3000 and do something).
240-
7. **Developer agent** takes each task and writes up what needs to be done to implement it. The description is in human-readable form.
241-
8. Finally, **Code Monkey agent** takes the Developer's description and the existing file and implements the changes. We realized this works much better than giving it to the Developer right away to implement changes.
242-
243-
For more details on the roles of agents employed by GPT Pilot, please take a look at [AGENTS.md](https://github.com/Pythagora-io/gpt-pilot/blob/main/pilot/helpers/agents/AGENTS.md)
207+
2. **Product Owner agent** like in real life, does nothing. :)
208+
3. **Specification Writer agent** asks a couple of questions to understand the requirements better if project description is not good enough.
209+
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.
210+
5. **Tech Lead agent** writes up development tasks that the Developer must implement.
211+
6. **Developer agent** takes each task and writes up what needs to be done to implement it. The description is in human-readable form.
212+
7. **Code Monkey agent** takes the Developer's description and the existing file and implements the changes.
213+
8. **Reviewer agent** reviews every step of the task and if something is done wrong Reviewer sends it back to Code Monkey.
214+
9. **Troubleshooter agent** helps you to give good feedback to GPT Pilot when something is wrong.
215+
10. **Debugger agent** hate to see him, but he is your best friend when things go south.
216+
11. **Technical Writer agent** writes documentation for the project.
244217

245218
![GPT Pilot Coding Workflow](https://github.com/Pythagora-io/gpt-pilot/assets/10895136/53ea246c-cefe-401c-8ba0-8e4dd49c987b)
246219

0 commit comments

Comments
 (0)