Skip to content

Commit

Permalink
add proper way to install and run in the README after the changes from …
Browse files Browse the repository at this point in the history 
…#60 (#76)
  • Loading branch information
@patillacode
patillacode authored Jun 16, 2023
1 parent 6f8e976 commit 25a6c31
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ GPT Engineer is made to be easy to adapt, extend, and make your agent learn how
## Usage

**Setup**:

- `pip install -r requirements.txt`
- `git clone https://github.com/AntonOsika/gpt-engineer.git`
- `cd gpt-engineer`
- `pip install .`
- `export OPENAI_API_KEY=[your api key]` with a key that has GPT4 access

**Run**:
- Create a new empty folder with a `main_prompt` file (or copy the example folder `cp -r example/ my-new-project`)
- Fill in the `main_prompt` in your new folder
- Run `python main.py my-new-project`
- Run `gpt-engineer my-new-project`

**Results**:
- Check the generated files in my-new-project/workspace
Expand Down

2 comments on commit 25a6c31

@kelvinrrivera
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Windows users: Instead of using export OPENAI_API_KEY=[your api key] (as you would in Unix-based systems), you should use setx OPENAI_API_KEY "<your_key>". Remember to replace <your_key> with your actual OpenAI API key. After making this change, you may need to restart your terminal or command session for the changes to take effect.

@patillacode
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@promptDeveloper

export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx in your terminal.

Although some people are asking for .env support it is not available for now.

Please sign in to comment.