Skip to content

docs: replace --cache=false with --disable-cache #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```