Skip to main content

FAQs

I don't have Homebrew, how can I install GPTScript?​

On macOS and Linux, you can alternatively install via: curl https://get.gptscript.ai/install.sh | sh

On all supported systems, you download and install the archive for your platform and architecture from the releases page.

Does GPTScript have an SDK or API I can program against?​

Currently, there are three SDKs being maintained: Python, Node, and Go. They are under development and are being iterated on relatively rapidly. The READMEs in each repository contain the most up-to-date documentation for the functionality of each.

I see there's a --disable-cache flag. How does caching working in GPTScript?​

GPTScript leverages caching to speed up execution and reduce LLM costs. There are two areas cached by GPTScript:

  • Git commit hash lookups for tools
  • LLM responses

Caching is enabled for both of these by default. It can be disabled via the --disable-cache flag. Below is an explanation of how these areas behave when caching is enabled and disabled.

Git commit hash lookups for tools​

When a remote tool or context is included in your script (like so: Tools: github.com/gptscript-ai/browser) and then invoked during script execution, GPTScript will pull the Git repo for that tool and build it. The tool's repo and build will be stored in your system's cache directory (at $XDG_CACHE_HOME/gptscript/repos). Subsequent invocations of the tool leverage that cache. When the cache is enabled, GPTScript will only check for a newer version of the tool once an hour; if an hour hasn't passed since the last check, it will just use the one it has. If this is the first invocation and the tool doesn't yet exist in the cache, it will be pulled and built as normal.

When the cache is disabled, GPTScript will check that it has the latest version of the tool (meaning the latest git commit for the repo) on every single invocation of the tool. If GPTScript determines it already has the latest version, that build will be used as-is. In other words, disabling the cache DOES NOT force GPTScript to rebuild the tool, it only forces GPTScript to always check if it has the latest version.

LLM responses​

In regard to LLM responses, when the cache is enabled, GPTScript will cache the LLM's response to a chat completion request. Each response is stored as a gob-encoded file in $XDG_CACHE_HOME/gptscript, where the file name is a hash of the chat completion request.

It is important to note that all messages in chat completion request are used to generate the hash that is used as the file name. This means that every message between user and LLM affects the cache lookup. So, when using GPTScript in chat mode, it is very unlikely you'll receive a cached LLM response. Conversely, non-chat GPTScript automations are much more likely to be consistent and thus make use of cached LLM responses.

I see there's a --workspace flag. How do I make use of that?​

Every invocation of GPTScript has a workspace directory available to it. By default, this directory is a one-off temp directory, but you can override this and explicitly set a workspace using the --workspace flag, like so:

gptscript --workspace . my-script.gpt

For more info, see the Workspace page.

I'm hitting GitHub's rate limit for unauthenticated requests when using GPTScript.​

By default, GPTScript makes unauthenticated requests to GitHub when pulling tools. Since GitHub's rate limits for unauthenticated requests are fairly low, running into them when developing with GPTScript is a common issue. To avoid this, you can get GPTScript to make authenticated requests -- which have higher rate limits -- by setting the GITHUB_AUTH_TOKEN environment variable to your github account's PAT (Personal Access Token). If you're already authenticated with the gh CLI, you can use its token by running:

export GITHUB_AUTH_TOKEN="$(gh auth token)"

Can I save my chat and resume it later?​

Yes! When you run GPTScript, be sure to specify the --save-chat-state-file argument like this:

gptscript --save-chat-state-file chat-state.json my-script.gpt

Then, when you want to resume your chat, you can use the --chat-state argument to specify the file you saved:

gptscript --chat-state chat-state.json my-script.gpt