From 8d6af6b4658ad686d8312b8431e0eb216dbe8a81 Mon Sep 17 00:00:00 2001 From: Grant Linville Date: Fri, 12 Apr 2024 10:18:02 -0400 Subject: [PATCH] docs: replace --cache=false with --disable-cache (#236) Signed-off-by: Grant Linville --- docs/docs/03-tools/04-credentials.md | 10 ++++++---- examples/car-notifier/README.md | 2 +- examples/hamlet-summarizer/README.md | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/docs/03-tools/04-credentials.md b/docs/docs/03-tools/04-credentials.md index 617587aa..0d0c02cc 100644 --- a/docs/docs/03-tools/04-credentials.md +++ b/docs/docs/03-tools/04-credentials.md @@ -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\"}}" ``` @@ -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. diff --git a/examples/car-notifier/README.md b/examples/car-notifier/README.md index 2e6e097b..87ce99e1 100644 --- a/examples/car-notifier/README.md +++ b/examples/car-notifier/README.md @@ -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 ``` diff --git a/examples/hamlet-summarizer/README.md b/examples/hamlet-summarizer/README.md index ee172f16..0e37e1d4 100644 --- a/examples/hamlet-summarizer/README.md +++ b/examples/hamlet-summarizer/README.md @@ -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 ```