Skip to content

docs: update missing tools and commands#1

Open
yuzengbaao wants to merge 1 commit intomainfrom
fix/docs-typos-another
Open

docs: update missing tools and commands#1
yuzengbaao wants to merge 1 commit intomainfrom
fix/docs-typos-another

Conversation

@yuzengbaao
Copy link
Copy Markdown
Owner

Fixes Scottcjn#69

Updates README.md with the actual count of built-in tools (15, adding view_image) and commands (23, adding /image and /screenshot).

Copilot AI review requested due to automatic review settings March 21, 2026 12:47
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README’s stated tool/command counts and extends the documented lists to reflect recently added vision-related capabilities.

Changes:

  • Update headline counts to 15 tools and 23 commands
  • Update Tools section heading and add the view_image tool entry
  • Add /image and /screenshot command entries

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
| `/sessions` | List saved sessions |
| `/stats` | Show generation stats (tokens, time, tok/s) |
| `/status` | Server, model, context, git branch, stats |

Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an empty line inside the Commands Markdown table (after /status). In GitHub-flavored Markdown this breaks the table and the remaining rows will not render as part of the table. Remove the blank line or repeat the table header for the next section.

Suggested change

Copilot uses AI. Check for mistakes.
Comment thread README.md
| `/screenshot` | Take a screenshot and include in next prompt |
| `/about` | The manifesto |
| `/help` | Full command reference |
| `/exit` | Quit |
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README now states "Commands (23)", but the CLI also supports /quit (and /q) as exit aliases (see handle_slash in trashclaw.py). Consider documenting these aliases (or adjusting the command count wording) so the list matches the actual command surface area.

Suggested change
| `/exit` | Quit |
| `/exit` (`/quit`, `/q`) | Quit |

Copilot uses AI. Check for mistakes.
Comment thread README.md
| `git_status` | Show modified/staged/untracked files |
| `git_diff` | Show unstaged or staged changes |
| `git_commit` | Stage all changes and commit |

Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The blank line inside the Markdown table (between git_commit and clipboard) terminates the table in GitHub-flavored Markdown, causing the following rows (clipboard/think/view_image) to render outside the table. Remove the blank line (or add a new header/separator if you intend to start a second table).

Suggested change

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[EASY BOUNTY: 1 RTC] Fix a typo or improve any documentation

2 participants