Skip to content

Commit

Permalink
docs: replace --cache=false with --disable-cache (#236)
Browse files Browse the repository at this point in the history
Signed-off-by: Grant Linville <[email protected]>
  • Loading branch information
g-linville authored Apr 12, 2024
1 parent f4284f4 commit 8d6af6b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions docs/docs/03-tools/04-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ name: my-credential-tool

#!/usr/bin/env bash

output=$(gptscript -q --cache=false sys.prompt '{"message":"Please enter your fake credential.","fields":"credential","sensitive":"true"}')
output=$(gptscript -q --disable-cache sys.prompt '{"message":"Please enter your fake credential.","fields":"credential","sensitive":"true"}')
credential=$(echo $output | jq -r '.credential')
echo "{\"env\":{\"MY_ENV_VAR\":\"$credential\"}}"
```
Expand Down Expand Up @@ -57,10 +57,12 @@ This config file also has another parameter, `credsStore`, which indicates where

- `file` (default): The credentials are stored directly in the config file.
- `osxkeychain`: The credentials are stored in the macOS Keychain.
- `wincred`: The credentials are stored in the Windows Credential Manager.

In order to use `osxkeychain` as the credsStore, you must have the `gptscript-credential-osxkeychain` executable
available in your PATH. There will probably be better packaging for this in the future, but for now, you can build it
from the [repo](https://github.com/gptscript-ai/gptscript-credential-helpers).
In order to use `osxkeychain` or `wincred` as the credsStore, you must have the `gptscript-credential-*` executable
available in your PATH. There will probably be better packaging for this in the future, but for now, you can build them
from the [repo](https://github.com/gptscript-ai/gptscript-credential-helpers). (For wincred, make sure the executable
is called `gptscript-credential-wincred.exe`.)

There will likely be support added for other credential stores in the future.

Expand Down
2 changes: 1 addition & 1 deletion examples/car-notifier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ export PGURL=your-postgres-connection-url
export SENDGRID_API_KEY=your-sendgrid-api-key

# Run the script
gptscript --cache=false car-notifier.gpt
gptscript --disable-cache car-notifier.gpt
```
2 changes: 1 addition & 1 deletion examples/hamlet-summarizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ pip install -r requirements.txt
export OPENAI_API_KEY=your-api-key

# Run the example
gptscript --cache=false hamlet-summarizer.gpt
gptscript --disable-cache hamlet-summarizer.gpt
```

0 comments on commit 8d6af6b

Please sign in to comment.