Skip to content

Correct package for clipboard support #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShalokShalom wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Correct package for clipboard support #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 23 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ See [Getting Started](#getting-started) if you have any problems.

Toad is an interface to coding agents, such as Claude, Gemini, Codex, OpenHand, and many more.

Toad blends a traditional shell based workflow and powerful agentic AI, with an intuitive Terminal User Interface.
Toad blends a traditional shell-based workflow and powerful agentic AI with an intuitive Terminal User Interface.

<table>
<tbody>
Expand All @@ -51,9 +51,9 @@ Toad blends a traditional shell based workflow and powerful agentic AI, with an
Find, install, and run dozens of agents directly from the Toad UI.
<p>
There is a large and growing list of AI agents that work with Toad.
Discover agents from big tech and smaller Open Source projects.
Discover agents from big tech and smaller open-source projects.
<p>
Developers can add support for their own agents, via the <a href="https://agentclientprotocol.com/overview/introduction">Agent Client Protocol</a>.
Developers can add support for their own agents via the <a href="https://agentclientprotocol.com/overview/introduction">Agent Client Protocol</a>.
</td>
<td>
<img alt="Screenshot 2026-01-27 at 12 48 30" src="https://github.com/user-attachments/assets/f7bd3776-6405-47e5-9d1f-11a12a4ce3b2" />
Expand All @@ -64,14 +64,14 @@ Toad blends a traditional shell based workflow and powerful agentic AI, with an
<h3>Toad Shell</h3>
<p>
While most terminal agent interfaces can run commands (with the <kbd>!</kbd> syntax), they aren't running a shell.
If you change directory or set environment variables, they won't persist from one command to the next.
If you change the directory or set environment variables, they won't persist from one command to the next.
<p>
Output that contains more than simple text will typically be garbled, and anything interactive will fail or even break the TUI entirely.
<p>
Toad integrates a fully working shell with full-color output, interactive commands, and tab completion.
Allowing you to interleave prompts for the agent with terminal workflows.
<p>
At time of writing Toad is the only terminal UI which does this.
At the time of writing, Toad is the only terminal UI which does this.
</td>
<td><img src="https://github.com/user-attachments/assets/ac9247bb-3daa-4bb7-b3fd-e0bbd22475fa"/></td>
</tr>
Expand All @@ -90,9 +90,9 @@ Toad blends a traditional shell based workflow and powerful agentic AI, with an
<td>
<h3>File Picker</h3>
<p>
Add a file to your prompt with <kbd>@</kbd>, and toad will show a fuzzy file picker.
Add a file to your prompt with <kbd>@</kbd>, and Toad will show a fuzzy file picker.
<p>
Type a few characters from the filename or folder and Toad will refine the search as you type.
Type a few characters from the filename or folder, and Toad will refine the search as you type.
Hit <kbd>enter</kbd> to add the file to the prompt.
<p>
The fuzzy picker is great when you know the file you want to mention.
Expand All @@ -117,7 +117,7 @@ Toad blends a traditional shell based workflow and powerful agentic AI, with an
<h3>Elegant Markdown</h3>
<p>
Markdown is the language of LLMs (AI).
Toad's streaming Markdown support can display syntax highlighted code fences, elegant tables, quotes, lists, and more.
Toad's streaming Markdown support can display syntax-highlighted code fences, elegant tables, quotes, lists, and more.
</td>
<td>
<img src="https://github.com/user-attachments/assets/b650b407-f4ab-4cb9-8920-55c15073598e"/>
Expand All @@ -131,7 +131,7 @@ Toad blends a traditional shell based workflow and powerful agentic AI, with an
<p>
Tune Toad to your liking.
Almost everything in Toad may be tweaked.
If you want to create an ultra-minimal UI with nothing more than a prompt—you can!
If you want to create an ultra-minimal UI with nothing more than a prompt, you can!
</td>
<td>
<img src="https://github.com/user-attachments/assets/2ff0de12-c2e1-455b-954a-21e66c070dd8"/>
Expand Down Expand Up @@ -177,20 +177,25 @@ https://github.com/user-attachments/assets/ced36f4b-db02-4d29-8a0a-14ec64b22881
Toad runs on Linux and macOS. Native Windows support is currently lacking (but on the roadmap), but Toad will run quite well with WSL.

Toad is a terminal application.
Any terminal will work, although if you are using the default terminal on macOS you will get a much reduced experience.
I recommend [Ghostty](https://ghostty.org/) which is fully featured and has amazing performance.
Any terminal will work, although if you are using the default terminal on macOS, you will get a much-reduced experience.
I recommend [Ghostty](https://ghostty.org/), which is fully featured and has amazing performance.

### Clipboard

On Linux, you may need to install `xclip` to enable clipboard support.
On Linux, you may need to install `wl-clipboard` on modern systems, like Gnome and KDE, or `xclip` on X11-based desktops, to enable clipboard support.

On Debian and Ubuntu:
```
sudo apt install wl-clipboard
```
or
```
sudo apt install xclip
```

## Getting Started

The easiest way to install Toad is by pasting the following in to your terminal:
The easiest way to install Toad is by pasting the following into your terminal:

```bash
curl -fsSL batrachian.ai/install | sh
Expand All @@ -206,7 +211,7 @@ First [install UV](https://docs.astral.sh/uv/getting-started/installation/):
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Then use UV to install toad:
Then use UV to install Toad:

```bash
uv tool install -U batrachian-toad --python 3.14
Expand All @@ -230,7 +235,7 @@ You should see something like this:

<img alt="front-fs8" src="https://github.com/user-attachments/assets/8831f7de-5349-4b3f-9de9-d4565b513108" />

From this screen you will be able to find, install, and launch a coding agent.
From this screen, you will be able to find, install, and launch a coding agent.
If you already have an agent installed, you can skip the install step.
To launch an agent, select it and press <kbd>space</kbd>.

Expand Down Expand Up @@ -276,9 +281,7 @@ toad serve

Toad was built by [Will McGugan](https://github.com/willmcgugan) and is currently under active development.

To discuss Toad, see the Discussions tab, or join the #toad channel on the [Textualize discord server](https://discord.gg/Enf6Z3qhVr).


To discuss Toad, see the Discussions tab, or join the #toad channel on the [Discord server of Textualize.](https://discord.gg/Enf6Z3qhVr).

### Roadmap

Expand All @@ -289,9 +292,9 @@ Some planned features:
- Sessions (resume)
- Multiple agents
- Windows native support
- Builtin editor
- Built-in editor
- Sidebar (widgets)
- Git pending changes
- Git pending changes

### Reporting bugs

Expand Down