diff --git a/aider/commands.py b/aider/commands.py index 4c8933f7e..571b9372b 100644 --- a/aider/commands.py +++ b/aider/commands.py @@ -680,17 +680,21 @@ class Commands: def get_help_md(self): "Show help about all commands in markdown" - res = "" + res = """ +|Command|Description| +|:------|:----------| +""" commands = sorted(self.get_commands()) for cmd in commands: cmd_method_name = f"cmd_{cmd[1:]}" cmd_method = getattr(self, cmd_method_name, None) if cmd_method: description = cmd_method.__doc__ - res += f"- **{cmd}** {description}\n" + res += f"| **{cmd}** | {description} |\n" else: - res += f"- **{cmd}**\n" + res += f"| **{cmd}** | |\n" + res += "\n" return res def cmd_voice(self, args): diff --git a/aider/website/docs/commands.md b/aider/website/docs/commands.md index 0188aa4ef..3196a4f76 100644 --- a/aider/website/docs/commands.md +++ b/aider/website/docs/commands.md @@ -11,25 +11,29 @@ Aider supports commands from within the chat, which all start with `/`. from aider.commands import get_help_md cog.out(get_help_md()) ]]]--> -- **/add** Add files to the chat so GPT can edit them or review them in detail -- **/clear** Clear the chat history -- **/commit** Commit edits to the repo made outside the chat (commit message optional) -- **/diff** Display the diff of the last aider commit -- **/drop** Remove files from the chat session to free up context space -- **/exit** Exit the application -- **/git** Run a git command -- **/help** Ask questions about aider -- **/lint** Lint and fix provided files or in-chat files if none provided -- **/ls** List all known files and indicate which are included in the chat session -- **/model** Switch to a new LLM -- **/models** Search the list of available models -- **/quit** Exit the application -- **/run** Run a shell command and optionally add the output to the chat (alias: !) -- **/test** Run a shell command and add the output to the chat on non-zero exit code -- **/tokens** Report on the number of tokens used by the current chat context -- **/undo** Undo the last git commit if it was done by aider -- **/voice** Record and transcribe voice input -- **/web** Use headless selenium to scrape a webpage and add the content to the chat + +|Command|Description| +|:------|:----------| +| **/add** | Add files to the chat so GPT can edit them or review them in detail | +| **/clear** | Clear the chat history | +| **/commit** | Commit edits to the repo made outside the chat (commit message optional) | +| **/diff** | Display the diff of the last aider commit | +| **/drop** | Remove files from the chat session to free up context space | +| **/exit** | Exit the application | +| **/git** | Run a git command | +| **/help** | Ask questions about aider | +| **/lint** | Lint and fix provided files or in-chat files if none provided | +| **/ls** | List all known files and indicate which are included in the chat session | +| **/model** | Switch to a new LLM | +| **/models** | Search the list of available models | +| **/quit** | Exit the application | +| **/run** | Run a shell command and optionally add the output to the chat (alias: !) | +| **/test** | Run a shell command and add the output to the chat on non-zero exit code | +| **/tokens** | Report on the number of tokens used by the current chat context | +| **/undo** | Undo the last git commit if it was done by aider | +| **/voice** | Record and transcribe voice input | +| **/web** | Use headless selenium to scrape a webpage and add the content to the chat | + # Entering multi-line chat messages diff --git a/aider/website/docs/usage.md b/aider/website/docs/usage.md index ad6bf5870..c84d0dfd6 100644 --- a/aider/website/docs/usage.md +++ b/aider/website/docs/usage.md @@ -30,7 +30,7 @@ Git repo: .git with 258 files Repo-map: using 1024 tokens Use /help to see in-chat commands, run with --help to see cmd line args ─────────────────────────────────────────────────────────────────────── ->`Make a program that asks for a number and prints its factorial +> Make a program that asks for a number and prints its factorial ... ```