From da90e33cce7192cadfe9f5df92d6987681b4d29d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Bj=C3=A4reholt?= Date: Wed, 6 Nov 2024 15:01:31 +0100 Subject: [PATCH] docs: updated `gptme --help` output, fix command ordering --- README.md | 7 ++++++- gptme/commands.py | 11 +++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fa58df91..b633dbe6 100644 --- a/README.md +++ b/README.md @@ -244,6 +244,7 @@ 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 @@ -251,7 +252,7 @@ Usage: gptme [OPTIONS] [PROMPTS]... /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 index 535c2199..9c26b439 100644 --- a/gptme/commands.py +++ b/gptme/commands.py @@ -24,25 +24,25 @@ 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", @@ -50,10 +50,9 @@ "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())