Windows Setup

Short version

On Windows, follow the standard README.md, but to set API key do one of:

Choose either stable or development.

For stable release:

Run pip install gpt-engineer in the command line as an administrator

Or:

Open your web browser and navigate to the Python Package Index (PyPI) website: https://pypi.org/project/gpt-engineer/.
On the PyPI page for the gpt-engineer package, locate the "Download files" section. Here you'll find a list of available versions and their corresponding download links.
Identify the version of gpt-engineer you want to install and click on the associated download link. This will download the package file (usually a .tar.gz or .whl file) to your computer.
Once the package file is downloaded, open your Python development environment or IDE.
In your Python development environment, look for an option to install packages or manage dependencies. The exact location and terminology may vary depending on your IDE. For example, in PyCharm, you can go to "File" > "Settings" > "Project: <project-name>" > "Python Interpreter" to manage packages.
In the package management interface, you should see a list of installed packages. Look for an option to add or install a new package.
Click on the "Add Package" or "Install Package" button.
In the package installation dialog, choose the option to install from a file or from a local source.
Browse and select the downloaded gpt-engineer package file from your computer.

For development:

git clone git@github.com:AntonOsika/gpt-engineer.git
cd gpt-engineer
pip install -e .
- (or: make install && source venv/bin/activate for a venv)

With an api key from OpenAI:

Run set OPENAI_API_KEY=[your API key] in the command line

Or:

In the Start Menu, type to search for "Environment Variables" and click on "Edit the system environment variables".
In the System Properties window, click on the "Environment Variables" button.
In the Environment Variables window, you'll see two sections: User variables and System variables.
To set a user-specific environment variable, select the "New" button under the User variables section.
To set a system-wide environment variable, select the "New" button under the System variables section.
Enter the variable name "OPENAI_API_KEY" in the "Variable name" field.
Enter the variable value (e.g., your API key) in the "Variable value" field.
Click "OK" to save the changes.
Close any open command prompt or application windows and reopen them for the changes to take effect.

Now you can use %OPENAI_API_KEY% when prompted to input your key.

Create an empty folder. If inside the repo, you can:
- Run xcopy /E projects\example projects\my-new-project in the command line
- Or hold CTRL and drag the folder down to create a copy, then rename to fit your project
Fill in the prompt file in your new folder
gpt-engineer projects/my-new-project
- (Note, gpt-engineer --help lets you see all available options. For example --steps use_feedback lets you improve/fix code in a project)

By running gpt-engineer you agree to our ToS.