Skip to content

Commit 452de51

Browse files
drpebcakdrpebcak
authored
Merge pull request #442 from drpebcak/update-cli-docs
2 parents 5a38626 + 9e25715 commit 452de51

File tree

4 files changed

+33
-41
lines changed

4 files changed

+33
-41
lines changed

‎docs/docs/100-reference/01-command-line/gptscript.md

+33-32
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,39 @@ gptscript [flags] PROGRAM_FILE [INPUT...]
1212
### Options
1313

1414
```
15-
--cache-dir string Directory to store cache (default: $XDG_CACHE_HOME/gptscript) ($GPTSCRIPT_CACHE_DIR)
16-
--chat-state string The chat state to continue, or null to start a new chat and return the state ($GPTSCRIPT_CHAT_STATE)
17-
-C, --chdir string Change current working directory ($GPTSCRIPT_CHDIR)
18-
--color Use color in output (default true) ($GPTSCRIPT_COLOR)
19-
--config string Path to GPTScript config file ($GPTSCRIPT_CONFIG)
20-
--confirm Prompt before running potentially dangerous commands ($GPTSCRIPT_CONFIRM)
21-
--credential-context string Context name in which to store credentials ($GPTSCRIPT_CREDENTIAL_CONTEXT) (default "default")
22-
--credential-override string Credentials to override (ex: --credential-override github.com/example/cred-tool:API_TOKEN=1234) ($GPTSCRIPT_CREDENTIAL_OVERRIDE)
23-
--debug Enable debug logging ($GPTSCRIPT_DEBUG)
24-
--debug-messages Enable logging of chat completion calls ($GPTSCRIPT_DEBUG_MESSAGES)
25-
--default-model string Default LLM model to use ($GPTSCRIPT_DEFAULT_MODEL) (default "gpt-4o")
26-
--disable-cache Disable caching of LLM API responses ($GPTSCRIPT_DISABLE_CACHE)
27-
--disable-tui Don't use chat TUI but instead verbose output ($GPTSCRIPT_DISABLE_TUI)
28-
--dump-state string Dump the internal execution state to a file ($GPTSCRIPT_DUMP_STATE)
29-
--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)
30-
--force-chat Force an interactive chat session if even the top level tool is not a chat tool ($GPTSCRIPT_FORCE_CHAT)
31-
--force-sequential Force parallel calls to run sequentially ($GPTSCRIPT_FORCE_SEQUENTIAL)
32-
-h, --help help for gptscript
33-
-f, --input string Read input from a file ("-" for stdin) ($GPTSCRIPT_INPUT)
34-
--list-models List the models available and exit ($GPTSCRIPT_LIST_MODELS)
35-
--list-tools List built-in tools and exit ($GPTSCRIPT_LIST_TOOLS)
36-
--listen-address string Server listen address ($GPTSCRIPT_LISTEN_ADDRESS) (default "127.0.0.1:9090")
37-
--no-trunc Do not truncate long log messages ($GPTSCRIPT_NO_TRUNC)
38-
--openai-api-key string OpenAI API KEY ($OPENAI_API_KEY)
39-
--openai-base-url string OpenAI base URL ($OPENAI_BASE_URL)
40-
--openai-org-id string OpenAI organization ID ($OPENAI_ORG_ID)
41-
-o, --output string Save output to a file, or - for stdout ($GPTSCRIPT_OUTPUT)
42-
-q, --quiet No output logging (set --quiet=false to force on even when there is no TTY) ($GPTSCRIPT_QUIET)
43-
--server Start server ($GPTSCRIPT_SERVER)
44-
--sub-tool string Use tool of this name, not the first tool in file ($GPTSCRIPT_SUB_TOOL)
45-
--ui Launch the UI ($GPTSCRIPT_UI)
46-
--workspace string Directory to use for the workspace, if specified it will not be deleted on exit ($GPTSCRIPT_WORKSPACE)
15+
--cache-dir string Directory to store cache (default: $XDG_CACHE_HOME/gptscript) ($GPTSCRIPT_CACHE_DIR)
16+
--chat-state string The chat state to continue, or null to start a new chat and return the state ($GPTSCRIPT_CHAT_STATE)
17+
-C, --chdir string Change current working directory ($GPTSCRIPT_CHDIR)
18+
--color Use color in output (default true) ($GPTSCRIPT_COLOR)
19+
--config string Path to GPTScript config file ($GPTSCRIPT_CONFIG)
20+
--confirm Prompt before running potentially dangerous commands ($GPTSCRIPT_CONFIRM)
21+
--credential-context string Context name in which to store credentials ($GPTSCRIPT_CREDENTIAL_CONTEXT) (default "default")
22+
--credential-override string Credentials to override (ex: --credential-override github.com/example/cred-tool:API_TOKEN=1234) ($GPTSCRIPT_CREDENTIAL_OVERRIDE)
23+
--debug Enable debug logging ($GPTSCRIPT_DEBUG)
24+
--debug-messages Enable logging of chat completion calls ($GPTSCRIPT_DEBUG_MESSAGES)
25+
--default-model string Default LLM model to use ($GPTSCRIPT_DEFAULT_MODEL) (default "gpt-4o")
26+
--disable-cache Disable caching of LLM API responses ($GPTSCRIPT_DISABLE_CACHE)
27+
--disable-tui Don't use chat TUI but instead verbose output ($GPTSCRIPT_DISABLE_TUI)
28+
--dump-state string Dump the internal execution state to a file ($GPTSCRIPT_DUMP_STATE)
29+
--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)
30+
--force-chat Force an interactive chat session if even the top level tool is not a chat tool ($GPTSCRIPT_FORCE_CHAT)
31+
--force-sequential Force parallel calls to run sequentially ($GPTSCRIPT_FORCE_SEQUENTIAL)
32+
-h, --help help for gptscript
33+
-f, --input string Read input from a file ("-" for stdin) ($GPTSCRIPT_INPUT)
34+
--list-models List the models available and exit ($GPTSCRIPT_LIST_MODELS)
35+
--list-tools List built-in tools and exit ($GPTSCRIPT_LIST_TOOLS)
36+
--listen-address string Server listen address ($GPTSCRIPT_LISTEN_ADDRESS) (default "127.0.0.1:0")
37+
--no-trunc Do not truncate long log messages ($GPTSCRIPT_NO_TRUNC)
38+
--openai-api-key string OpenAI API KEY ($OPENAI_API_KEY)
39+
--openai-base-url string OpenAI base URL ($OPENAI_BASE_URL)
40+
--openai-org-id string OpenAI organization ID ($OPENAI_ORG_ID)
41+
-o, --output string Save output to a file, or - for stdout ($GPTSCRIPT_OUTPUT)
42+
-q, --quiet No output logging (set --quiet=false to force on even when there is no TTY) ($GPTSCRIPT_QUIET)
43+
--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)
44+
--server Start server ($GPTSCRIPT_SERVER)
45+
--sub-tool string Use tool of this name, not the first tool in file ($GPTSCRIPT_SUB_TOOL)
46+
--ui Launch the UI ($GPTSCRIPT_UI)
47+
--workspace string Directory to use for the workspace, if specified it will not be deleted on exit ($GPTSCRIPT_WORKSPACE)
4748
```
4849

4950
### SEE ALSO

‎docs/docs/100-reference/01-command-line/gptscript_eval.md

-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ gptscript eval [flags]
2626

2727
```
2828
--cache-dir string Directory to store cache (default: $XDG_CACHE_HOME/gptscript) ($GPTSCRIPT_CACHE_DIR)
29-
--chat-state string The chat state to continue, or null to start a new chat and return the state ($GPTSCRIPT_CHAT_STATE)
3029
-C, --chdir string Change current working directory ($GPTSCRIPT_CHDIR)
3130
--color Use color in output (default true) ($GPTSCRIPT_COLOR)
3231
--config string Path to GPTScript config file ($GPTSCRIPT_CONFIG)
@@ -39,8 +38,6 @@ gptscript eval [flags]
3938
--disable-cache Disable caching of LLM API responses ($GPTSCRIPT_DISABLE_CACHE)
4039
--dump-state string Dump the internal execution state to a file ($GPTSCRIPT_DUMP_STATE)
4140
--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)
42-
--force-chat Force an interactive chat session if even the top level tool is not a chat tool ($GPTSCRIPT_FORCE_CHAT)
43-
--force-sequential Force parallel calls to run sequentially ($GPTSCRIPT_FORCE_SEQUENTIAL)
4441
-f, --input string Read input from a file ("-" for stdin) ($GPTSCRIPT_INPUT)
4542
--no-trunc Do not truncate long log messages ($GPTSCRIPT_NO_TRUNC)
4643
--openai-api-key string OpenAI API KEY ($OPENAI_API_KEY)

‎docs/docs/100-reference/01-command-line/gptscript_fmt.md

-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ gptscript fmt [flags]
2020

2121
```
2222
--cache-dir string Directory to store cache (default: $XDG_CACHE_HOME/gptscript) ($GPTSCRIPT_CACHE_DIR)
23-
--chat-state string The chat state to continue, or null to start a new chat and return the state ($GPTSCRIPT_CHAT_STATE)
2423
-C, --chdir string Change current working directory ($GPTSCRIPT_CHDIR)
2524
--color Use color in output (default true) ($GPTSCRIPT_COLOR)
2625
--config string Path to GPTScript config file ($GPTSCRIPT_CONFIG)
@@ -33,8 +32,6 @@ gptscript fmt [flags]
3332
--disable-cache Disable caching of LLM API responses ($GPTSCRIPT_DISABLE_CACHE)
3433
--dump-state string Dump the internal execution state to a file ($GPTSCRIPT_DUMP_STATE)
3534
--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)
36-
--force-chat Force an interactive chat session if even the top level tool is not a chat tool ($GPTSCRIPT_FORCE_CHAT)
37-
--force-sequential Force parallel calls to run sequentially ($GPTSCRIPT_FORCE_SEQUENTIAL)
3835
-f, --input string Read input from a file ("-" for stdin) ($GPTSCRIPT_INPUT)
3936
--no-trunc Do not truncate long log messages ($GPTSCRIPT_NO_TRUNC)
4037
--openai-api-key string OpenAI API KEY ($OPENAI_API_KEY)

‎docs/docs/100-reference/01-command-line/gptscript_parse.md

-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ gptscript parse [flags]
2020

2121
```
2222
--cache-dir string Directory to store cache (default: $XDG_CACHE_HOME/gptscript) ($GPTSCRIPT_CACHE_DIR)
23-
--chat-state string The chat state to continue, or null to start a new chat and return the state ($GPTSCRIPT_CHAT_STATE)
2423
-C, --chdir string Change current working directory ($GPTSCRIPT_CHDIR)
2524
--color Use color in output (default true) ($GPTSCRIPT_COLOR)
2625
--config string Path to GPTScript config file ($GPTSCRIPT_CONFIG)
@@ -33,8 +32,6 @@ gptscript parse [flags]
3332
--disable-cache Disable caching of LLM API responses ($GPTSCRIPT_DISABLE_CACHE)
3433
--dump-state string Dump the internal execution state to a file ($GPTSCRIPT_DUMP_STATE)
3534
--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)
36-
--force-chat Force an interactive chat session if even the top level tool is not a chat tool ($GPTSCRIPT_FORCE_CHAT)
37-
--force-sequential Force parallel calls to run sequentially ($GPTSCRIPT_FORCE_SEQUENTIAL)
3835
-f, --input string Read input from a file ("-" for stdin) ($GPTSCRIPT_INPUT)
3936
--no-trunc Do not truncate long log messages ($GPTSCRIPT_NO_TRUNC)
4037
--openai-api-key string OpenAI API KEY ($OPENAI_API_KEY)

0 commit comments

Comments
 (0)