Skip to content

Commit 5dbd020

Browse files
committed
docs: improve quickstart documentation for Windows OS users
1 parent da3f157 commit 5dbd020

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

docs/quickstart.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,18 @@ python -m venv .venv
1414

1515
Do this every time you start a new terminal session.
1616

17+
On macOS or Linux:
18+
1719
```bash
1820
source .venv/bin/activate
1921
```
2022

23+
On Windows:
24+
25+
```cmd
26+
.venv\Scripts\activate
27+
```
28+
2129
### Install the Agents SDK
2230

2331
```bash
@@ -28,10 +36,26 @@ pip install openai-agents # or `uv add openai-agents`, etc
2836

2937
If you don't have one, follow [these instructions](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key) to create an OpenAI API key.
3038

39+
These commands set the key for your current terminal session.
40+
41+
On macOS or Linux:
42+
3143
```bash
3244
export OPENAI_API_KEY=sk-...
3345
```
3446

47+
On Windows PowerShell:
48+
49+
```powershell
50+
$env:OPENAI_API_KEY = "sk-..."
51+
```
52+
53+
On Windows Command Prompt:
54+
55+
```cmd
56+
set "OPENAI_API_KEY=sk-..."
57+
```
58+
3559
## Create your first agent
3660

3761
Agents are defined with instructions, a name, and optional configuration such as a specific model.

0 commit comments

Comments
 (0)