docs: updated gptme --help output, fix command ordering

ErikBjare · Nov 6, 2024 · da90e33 · da90e33
1 parent 1de06c6
commit da90e33
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -244,14 +244,15 @@ Usage: gptme [OPTIONS] [PROMPTS]...
   Available commands:
     /undo         Undo the last action
     /log          Show the conversation log
+    /tools        Show available tools
     /edit         Edit the conversation in your editor
     /rename       Rename the conversation
     /fork         Create a copy of the conversation with a new name
     /summarize    Summarize the conversation
     /replay       Re-execute codeblocks in the conversation, wont store output in log
     /impersonate  Impersonate the assistant
     /tokens       Show the number of tokens used
-    /tools        Show available tools
+    /export       Export conversation as standalone HTML
     /help         Show this help message
     /exit         Exit the program
 
@@ -268,6 +269,10 @@ Options:
   -n, --non-interactive  Force non-interactive mode. Implies --no-confirm.
   --system TEXT          System prompt. Can be 'full', 'short', or something
                          custom.
+  -t, --tools TEXT       Comma-separated list of tools to allow. Available:
+                         read, save, append, patch, shell, subagent, tmux,
+                         browser, gh, chats, screenshot, vision, computer,
+                         python.
   --no-stream            Don't stream responses
   --show-hidden          Show hidden system messages.
   -v, --verbose          Show verbose output.

diff --git a/gptme/commands.py b/gptme/commands.py
@@ -24,36 +24,35 @@
 logger = logging.getLogger(__name__)
 
 Actions = Literal[
+    "undo",
     "log",
+    "tools",
     "edit",
     "rename",
     "fork",
     "summarize",
-    "context",
     "replay",
-    "undo",
     "impersonate",
-    "tools",
     "tokens",
+    "export",
     "help",
     "exit",
-    "export",
 ]
 
 action_descriptions: dict[Actions, str] = {
     "undo": "Undo the last action",
     "log": "Show the conversation log",
+    "tools": "Show available tools",
     "edit": "Edit the conversation in your editor",
     "rename": "Rename the conversation",
     "fork": "Create a copy of the conversation with a new name",
     "summarize": "Summarize the conversation",
     "replay": "Re-execute codeblocks in the conversation, wont store output in log",
     "impersonate": "Impersonate the assistant",
     "tokens": "Show the number of tokens used",
-    "tools": "Show available tools",
+    "export": "Export conversation as standalone HTML",
     "help": "Show this help message",
     "exit": "Exit the program",
-    "export": "Export conversation as standalone HTML",
 }
 COMMANDS = list(action_descriptions.keys())