Skip to content

Commit 403fe8b

Browse files
committed
docs: add powershell command and fix phrasing in docs
Signed-off-by: tylerslaton <[email protected]>
1 parent af0d2a3 commit 403fe8b

File tree

3 files changed

+21
-5
lines changed

3 files changed

+21
-5
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,18 @@ Download and install the archive for your platform and architecture from the [re
5959

6060
### 2. Get an API key from [OpenAI](https://platform.openai.com/api-keys).
6161

62+
#### macOS and Linux
63+
6264
```shell
6365
export OPENAI_API_KEY="your-api-key"
6466
```
6567

68+
#### Windows
69+
70+
```powershell
71+
$env:OPENAI = 'your-api-key'
72+
```
73+
6674
### 3. Run Hello World
6775

6876
```shell

docs/docs/02-getting-started.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,18 @@ Download and install the archive for your platform and architecture from the [re
2626

2727
### 2. Get an API key from [OpenAI](https://platform.openai.com/api-keys).
2828

29+
#### macOS and Linux
30+
2931
```shell
3032
export OPENAI_API_KEY="your-api-key"
3133
```
3234

35+
#### Windows
36+
37+
```powershell
38+
$env:OPENAI = 'your-api-key'
39+
```
40+
3341
### 3. Run Hello World
3442

3543
```shell

docs/docs/100-tools/02-authoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For example:
3030
description: This is a tool that calls a binary.
3131
args: arg1: The first argument.
3232

33-
#!/usr/bin/env ./path/to/binary
33+
#!/usr/bin/env ./path/to/binary --arg1="${arg1}"
3434
```
3535

3636
## Shell
@@ -42,11 +42,11 @@ args: arg1: The first argument.
4242

4343
#!/usr/bin/env sh
4444
echo "Hello, world!"
45-
./path/to/script.sh
45+
./path/to/script.sh --arg1="${arg1}"
4646
```
4747

4848
## Python
49-
You can also call Python scripts directly the same way. For example:
49+
You can call Python scripts directly, for example:
5050

5151
```yaml
5252
description: This is a tool that calls a Python script.
@@ -69,7 +69,7 @@ python3 ./path/to/script.py
6969

7070
## Node
7171

72-
You can also call Node.js scripts directly the same way. For example:
72+
You can call Node.js scripts directly, for example:
7373

7474
```yaml
7575
description: This is a tool that calls a Node.js script.
@@ -91,7 +91,7 @@ node ./path/to/script.js
9191

9292
## Golang
9393

94-
You can also call Golang binaries directly the same way. For example:
94+
You can call Golang binaries directly, for example:
9595

9696
```yaml
9797
description: This is a tool that calls a Golang binary.

0 commit comments

Comments
 (0)