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.26.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.26-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: batrachian_toad-0.5.26.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.26.tar.gz
Algorithm Hash digest
SHA256 010b3e47f5eb8d83a84f8ec7db1458beddca056d1c293426db3ca738f3a7969a
MD5 5bfcff96a7db97da6db3d71c53bf1c56
BLAKE2b-256 5bfce9285f2c68630daa538073e8bd67ef7693a0f446a5ebf6c31aad4f4492c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: batrachian_toad-0.5.26-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.26-py3-none-any.whl
Algorithm Hash digest
SHA256 6f9b26ce0feefea7eec7f5ee270d27bcd5a52b69e58595fd03eaa299e969b8da
MD5 bf1f31553c1ecce17869c8cd238b997e
BLAKE2b-256 f42c56ddba682167cf43e0ea7be84b5d0a6eb963b98798c35eecca1b633e81a7

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