Usage:
gptscript [flags] PROGRAM_FILE [INPUT...]
gptscript [command]
Available Commands:
credential List stored credentials
eval
fmt
getenv Looks up an environment variable for use in GPTScript tools
parse
Flags:
--cache-dir string Directory to store cache (default: $XDG_CACHE_HOME/gptscript) ($GPTSCRIPT_CACHE_DIR)
--chat-state string The chat state to continue, or null to start a new chat and return the state ($GPTSCRIPT_CHAT_STATE)
-C, --chdir string Change current working directory ($GPTSCRIPT_CHDIR)
--color Use color in output (default true) ($GPTSCRIPT_COLOR)
--config string Path to GPTScript config file ($GPTSCRIPT_CONFIG)
--confirm Prompt before running potentially dangerous commands ($GPTSCRIPT_CONFIRM)
--credential-context strings Context name(s) in which to store credentials ($GPTSCRIPT_CREDENTIAL_CONTEXT)
--credential-override strings Credentials to override (ex: --credential-override github.com/example/cred-tool:API_TOKEN=1234) ($GPTSCRIPT_CREDENTIAL_OVERRIDE)
--debug Enable debug logging ($GPTSCRIPT_DEBUG)
--debug-messages Enable logging of chat completion calls ($GPTSCRIPT_DEBUG_MESSAGES)
--default-model string Default LLM model to use ($GPTSCRIPT_DEFAULT_MODEL) (default "gpt-4o")
--default-model-provider string Default LLM model provider to use, this will override OpenAI settings ($GPTSCRIPT_DEFAULT_MODEL_PROVIDER)
--disable-cache Disable caching of LLM API responses ($GPTSCRIPT_DISABLE_CACHE)
--disable-tui Don't use chat TUI but instead verbose output ($GPTSCRIPT_DISABLE_TUI)
--dump-state string Dump the internal execution state to a file ($GPTSCRIPT_DUMP_STATE)
--events-stream-to string Stream events to this location, could be a file descriptor/handle (e.g. fd://2), filename, or named pipe (e.g. \\.\pipe\my-pipe) ($GPTSCRIPT_EVENTS_STREAM_TO)
--force-chat Force an interactive chat session if even the top level tool is not a chat tool ($GPTSCRIPT_FORCE_CHAT)
--force-sequential Force parallel calls to run sequentially ($GPTSCRIPT_FORCE_SEQUENTIAL)
--github-enterprise-hostname string The host name for a Github Enterprise instance to enable for remote loading ($GPTSCRIPT_GITHUB_ENTERPRISE_HOSTNAME)
-h, --help help for gptscript
-f, --input string Read input from a file ("-" for stdin) ($GPTSCRIPT_INPUT_FILE)
--list-models List the models available and exit ($GPTSCRIPT_LIST_MODELS)
--list-tools List built-in tools and exit ($GPTSCRIPT_LIST_TOOLS)
--no-trunc Do not truncate long log messages ($GPTSCRIPT_NO_TRUNC)
--openai-api-key string OpenAI API KEY ($OPENAI_API_KEY)
--openai-base-url string OpenAI base URL ($OPENAI_BASE_URL)
--openai-org-id string OpenAI organization ID ($OPENAI_ORG_ID)
-o, --output string Save output to a file, or - for stdout ($GPTSCRIPT_OUTPUT)
-q, --quiet No output logging (set --quiet=false to force on even when there is no TTY) ($GPTSCRIPT_QUIET)
--save-chat-state-file string A file to save the chat state to so that a conversation can be resumed with --chat-state ($GPTSCRIPT_SAVE_CHAT_STATE_FILE)
--sub-tool string Use tool of this name, not the first tool in file ($GPTSCRIPT_SUB_TOOL)
--system-tools-dir string Directory that contains system managed tool for which GPTScript will not manage the runtime ($GPTSCRIPT_SYSTEM_TOOLS_DIR)
--ui Launch the UI ($GPTSCRIPT_UI)
-v, --version version for gptscript
--workspace string Directory to use for the workspace, if specified it will not be deleted on exit ($GPTSCRIPT_WORKSPACE)
Use "gptscript [command] --help" for more information about a command.
Options (35)
| Option | Description | Source |
|---|---|---|
--cache-dir string | Directory to store cache (default: $XDG_CACHE_HOME/gptscript) ($GPTSCRIPT_CACHE_DIR) | help |
--chat-state string | The chat state to continue, or null to start a new chat and return the state ($GPTSCRIPT_CHAT_STATE) | help |
-C, --chdir string | Change current working directory ($GPTSCRIPT_CHDIR) | help |
--color | Use color in output (default true) ($GPTSCRIPT_COLOR) | help |
--config string | Path to GPTScript config file ($GPTSCRIPT_CONFIG) | help |
--confirm | Prompt before running potentially dangerous commands ($GPTSCRIPT_CONFIRM) | help |
--credential-context strings | Context name(s) in which to store credentials ($GPTSCRIPT_CREDENTIAL_CONTEXT) | help |
--credential-override strings | Credentials to override (ex: --credential-override github.com/example/cred-tool:API_TOKEN=1234) ($GPTSCRIPT_CREDENTIAL_OVERRIDE) | help |
--debug | Enable debug logging ($GPTSCRIPT_DEBUG) | help |
--debug-messages | Enable logging of chat completion calls ($GPTSCRIPT_DEBUG_MESSAGES) | help |
--default-model string | Default LLM model to use ($GPTSCRIPT_DEFAULT_MODEL) (default "gpt-4o") | help |
--default-model-provider string | Default LLM model provider to use, this will override OpenAI settings ($GPTSCRIPT_DEFAULT_MODEL_PROVIDER) | help |
--disable-cache | Disable caching of LLM API responses ($GPTSCRIPT_DISABLE_CACHE) | help |
--disable-tui | Don't use chat TUI but instead verbose output ($GPTSCRIPT_DISABLE_TUI) | help |
--dump-state string | Dump the internal execution state to a file ($GPTSCRIPT_DUMP_STATE) | help |
--events-stream-to string | Stream events to this location, could be a file descriptor/handle (e.g. fd://2), filename, or named pipe (e.g. \\.\pipe\my-pipe) ($GPTSCRIPT_EVENTS_STREAM_TO) | help |
--force-chat | Force an interactive chat session if even the top level tool is not a chat tool ($GPTSCRIPT_FORCE_CHAT) | help |
--force-sequential | Force parallel calls to run sequentially ($GPTSCRIPT_FORCE_SEQUENTIAL) | help |
--github-enterprise-hostname string | The host name for a Github Enterprise instance to enable for remote loading ($GPTSCRIPT_GITHUB_ENTERPRISE_HOSTNAME) | help |
-h, --help | help for gptscript | help |
-f, --input string | Read input from a file ("-" for stdin) ($GPTSCRIPT_INPUT_FILE) | help |
--list-models | List the models available and exit ($GPTSCRIPT_LIST_MODELS) | help |
--list-tools | List built-in tools and exit ($GPTSCRIPT_LIST_TOOLS) | help |
--no-trunc | Do not truncate long log messages ($GPTSCRIPT_NO_TRUNC) | help |
--openai-api-key string | OpenAI API KEY ($OPENAI_API_KEY) | help |
--openai-base-url string | OpenAI base URL ($OPENAI_BASE_URL) | help |
--openai-org-id string | OpenAI organization ID ($OPENAI_ORG_ID) | help |
-o, --output string | Save output to a file, or - for stdout ($GPTSCRIPT_OUTPUT) | help |
-q, --quiet | No output logging (set --quiet=false to force on even when there is no TTY) ($GPTSCRIPT_QUIET) | help |
--save-chat-state-file string | A file to save the chat state to so that a conversation can be resumed with --chat-state ($GPTSCRIPT_SAVE_CHAT_STATE_FILE) | help |
--sub-tool string | Use tool of this name, not the first tool in file ($GPTSCRIPT_SUB_TOOL) | help |
--system-tools-dir string | Directory that contains system managed tool for which GPTScript will not manage the runtime ($GPTSCRIPT_SYSTEM_TOOLS_DIR) | help |
--ui | Launch the UI ($GPTSCRIPT_UI) | help |
-v, --version | version for gptscript | help |
--workspace string | Directory to use for the workspace, if specified it will not be deleted on exit ($GPTSCRIPT_WORKSPACE) | help |