Skip to main content

A unified experience for AI in your terminal.

Project description

Toad

A unified interface for AI in your terminal (release announcement).

Run coding agents seamlessly under a single beautiful terminal UI, thanks to the ACP protocol.

Screenshot 2025-10-23 at 08 58 58 Screenshot 2025-10-23 at 08 59 04
Screenshot 2025-10-23 at 08 59 22 Screenshot 2025-10-23 at 08 59 37

Video

Watch a preview of the Toad User Interface:

https://github.com/user-attachments/assets/ced36f4b-db02-4d29-8a0a-14ec64b22881

Compatibility

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 which is fully featured and has amazing performance.

Clipboard

On Linux, you may need to install xclip to enable clipboard support.

sudo apt install xclip

Alternative shells

I'd like Toad to run multiple shells, but there are some compatibility issues I need to work out first, so for the moment the default is to use /bin/sh.

You can change the shell in settings. If you have any success, let me know.

Getting Started

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

curl -fsSL batrachian.ai/install | sh

You should now have toad installed.

If that doesn't work for any reason, then you can install with the following steps:

First install UV:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then use UV to install toad:

uv tool install -U batrachian-toad --python 3.14

Using Toad

Launch Toad with the following:

toad

You should see something like this:

front-fs8

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 space.

The footer will always display the most significant keys for the current context. To see all the keys, summon the command palette with ctrl+p and search for "keys".

Toad CLI

When running Toad, the current working directory is assumed to be your project directory. To use another project directory, add the path to the command. For example:

toad ~/projects/my-awesome-app

If you want to skip the initial agent screen, add the -a switch with the name of your chosen agent. For example:

toad -a open-hands

To see all subcommands and switches, add the --help switch:

toad --help

Web server

You can run Toad as a web application.

Run the following, and click the link in the terminal:

toad serve

textual-serve

Toad development

Toad was built by Will McGugan and is currently under active development.

To discuss Toad, see the Discussions tab, or join the #toad channel on the Textualize discord server.

Roadmap

Some planned features:

  • UI for MCP servers
  • Expose model selection (waiting on ACP update)
  • Sessions
  • Multiple agents
  • Windows native support
  • Builtin editor
  • Sidebar (widgets)
    • Git pending changes

Reporting bugs

This project is trialling a non-traditional approach to issues. Before an issue is created, there must be a post in Dicussions, approved by a Toad dev (Currently @willmcgugan).

By allowing the discussions to happen in the Discussion tabs, issues can be reserved for actionable tasks with a clear description and goal.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

batrachian_toad-0.5.28.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

batrachian_toad-0.5.28-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file batrachian_toad-0.5.28.tar.gz.

File metadata

  • Download URL: batrachian_toad-0.5.28.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for batrachian_toad-0.5.28.tar.gz
Algorithm Hash digest
SHA256 d5e40264cea85bc6209e15022daf6291ff99b2cdf2fd845584248c783af8d4af
MD5 cb4a83f9c2560f402a28e9955f1ef4c4
BLAKE2b-256 33234db550587306c8739d1c86e04ed7c4a77172aec97ff8ae62de0e9c790536

See more details on using hashes here.

File details

Details for the file batrachian_toad-0.5.28-py3-none-any.whl.

File metadata

  • Download URL: batrachian_toad-0.5.28-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for batrachian_toad-0.5.28-py3-none-any.whl
Algorithm Hash digest
SHA256 9b74f898ca3c827ddf4020b060c6c8e917fe25164d27dbe3b53fac3b281462d6
MD5 9dc7f237bd4cf0073670745cadd3e826
BLAKE2b-256 54e98aad3b5f88d1eba3e41165df2ea101f18a32a2ac5c3dbf6e7d9eed7523cd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page