Skip to content

Commit

Permalink
Merge pull request #889 from RukshanJS/feat/gpte-command
Browse files Browse the repository at this point in the history
I think this is a good idea, merging into the refactor-poetry branch.
  • Loading branch information
ATheorell authored Dec 5, 2023
2 parents 8e95858 + b3e5f37 commit 8357c08
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,17 +61,21 @@ There are two ways to work with GPT-engineer: new code mode (the default), and i
### Creating new code
- Create an empty folder for your project anywhere on your computer
- Create a file called `prompt` (no extension) inside your new folder and fill it with instructions
- Run `gpt-engineer <project_dir>` with a relative path to your folder
- For example: `gpt-engineer projects/my-new-project` from the gpt-engineer directory root with your new folder in `projects/`
- Run `gpte <project_dir>` with a relative path to your folder
- For example: `gpte projects/my-new-project` from the gpt-engineer directory root with your new folder in `projects/`

### Improving Existing Code
- Locate a folder with code which you want to improve anywhere on your computer
- Create a file called `prompt` (no extension) inside your new folder and fill it with instructions for how you want to improve the code
- Run `gpt-engineer <project_dir> -i` with a relative path to your folder
- For example: `gpt-engineer projects/my-old-project` from the gpt-engineer directory root with your folder in `projects/`
- Run `gpte <project_dir> -i` with a relative path to your folder
- For example: `gpte projects/my-old-project` from the gpt-engineer directory root with your folder in `projects/`

By running gpt-engineer you agree to our [terms](https://github.com/AntonOsika/gpt-engineer/blob/main/TERMS_OF_USE.md).

### Note

- To run this tool, the new command `gpte` is recommended for better user experience. However, the earlier default commands `gpt-engineer` and `ge` are also supported.


## Features

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ sphinx_copybutton = ">=0.5.2"
[tool.poetry.scripts]
gpt-engineer = 'gpt_engineer.applications.cli.main:app'
ge = 'gpt_engineer.applications.cli.main:app'
gpte = 'gpt_engineer.applications.cli.main:app'
bench = 'gpt_engineer.benchmark.__main__:main'

[tool.poetry.extras]
Expand Down

0 comments on commit 8357c08

Please sign in to comment.