installation.rst

Installation

Stable release

To install gpt-engineer, run this command in your terminal:

$ python -m pip install gpt-engineer

This is the preferred method to install gpt-engineer, as it will always install the most recent stable release.

If you don't have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for gpt-engineer can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone https://github.com/gpt-engineer-org/gpt-engineer.git

Once you have a copy of the source, you can install it with:

$ cd gpt-engineer
$ poetry install
$ poetry shell

Troubleshooting

For mac and linux system, there are sometimes slim python installations that do not include the gpt-engineer requirement tkinter, which is a standard library and thus not pip installable.

To install tkinter on mac, you can for example use brew:

$ brew install python-tk

On debian-based linux systems you can use:

$ sudo apt-get install python3-tk