Metadata-Version: 2.4
Name: batrachian-toad
Version: 0.6.14
Summary: A unified experience for AI in your terminal.
License-File: LICENSE
Requires-Python: >=3.14
Requires-Dist: aiosqlite>=0.22.1
Requires-Dist: bashlex>=0.18
Requires-Dist: click>=8.2.1
Requires-Dist: httpx>=0.28.1
Requires-Dist: notify-py>=0.3.43
Requires-Dist: packaging>=25.0
Requires-Dist: pathspec>=0.12.1
Requires-Dist: platformdirs>=4.9.4
Requires-Dist: psutil>=7.2.1
Requires-Dist: pyperclip>=1.11.0
Requires-Dist: rich>=14.3.3
Requires-Dist: setproctitle>=1.3.7
Requires-Dist: textual-serve>=1.1.2
Requires-Dist: textual-speedups==0.2.1
Requires-Dist: textual[syntax]>=8.2.1
Requires-Dist: tree-sitter>=0.24.0
Requires-Dist: typeguard==4.4.4
Requires-Dist: watchdog>=6.0.0
Requires-Dist: xdg-base-dirs>=6.0.2
Description-Content-Type: text/markdown

# Toad

A unified interface for AI in your terminal ([release announcement](https://willmcgugan.github.io/toad-released/)).

     Screenshot 2026-01-30 at 19 23 54 
     Screenshot 2026-01-30 at 19 21 00    

     Screenshot 2026-01-30 at 19 29 47
     Screenshot 2026-01-30 at 19 30 08

## Quickstart

Install:

```
curl -fsSL batrachian.ai/install | sh
```

Run:

```
toad
```

See [Getting Started](#getting-started) if you have any problems.

## What is Toad?

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.

AI "App store"
        
        Find, install, and run dozens of agents directly from the Toad UI.
        
        There is a large and growing list of AI agents that work with Toad.
        Discover agents from big tech and smaller Open Source projects.
        
        Developers can add support for their own agents, via the Agent Client Protocol (https://agentclientprotocol.com/overview/introduction).
      
               Screenshot 2026-01-27 at 12 48 30

Toad Shell
      
      While most terminal agent interfaces can run commands (with the ! 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.
      
      Output that contains more than simple text will typically be garbled, and anything interactive will fail or even break the TUI entirely.
      
      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.
      
      At time of writing Toad is the only terminal UI which does this.

Prompt Editor
        
        Toad has a nice Markdown prompt editor, with syntax highlighting for code fences.
        Full mouse support, cut and paste, many keybindings and shortcuts.

File Picker
        
        Add a file to your prompt with @, and toad will show a fuzzy file picker.
        
        Type a few characters from the filename or folder and Toad will refine the search as you type.
        Hit enter to add the file to the prompt.
        
        The fuzzy picker is great when you know the file you want to mention.
        If you want to explore your files, you can press tab to switch to an interactive tree control.                

Beautiful Diffs
        
        Side-by-side or unified diffs, with syntax highlighting for most languages.      
      
               Screenshot 2026-01-27 at 12 44 22

Elegant Markdown
        
        Markdown is the language of LLMs (AI).
        Toad's streaming Markdown support can display syntax highlighted code fences, elegant tables, quotes, lists, and more.

Simple Settings
        
        An intuitive settings system (no need to manually edit JSON files).
        
        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!                

Concurrent sessions
        
        Launch and run multiple agents from potentially different providers.
        
        Hit ctrl+s to show the current state of all your agents in one screen.

               Screenshot 2026-02-16 at 17 33 40-fs8

Session Resume
        
        Resume previous sessions with your agent.    
        
        Hit ctrl+r to pick a previous session to resume.
      
               Screenshot 2026-02-01 at 16 57 46

## 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](https://ghostty.org/) 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
```

## Getting Started

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

```bash
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](https://docs.astral.sh/uv/getting-started/installation/):

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

Then use UV to install toad:

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

Toad is also available on [conda-forge](https://conda-forge.org), and can be installed using [pixi](https://pixi.prefix.dev/latest/#installation):

```bash
pixi global install batrachian-toad
```

## Using Toad

Launch Toad with the following:

```bash
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, press F1 to display the help panel.

### 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:

```bash
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:

```bash
toad -a open-hands
```

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

```bash
toad --help
```

### Web server

You can run Toad as a web application.

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

```bash
toad serve
```

![textual-serve](https://github.com/user-attachments/assets/1d861d48-d30b-44cd-972d-5986a01360bf)

## Toad development

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



### Roadmap

Some planned features:

- UI for MCP servers
- Expose model selection (waiting on ACP update)
- Sessions (resume)
- 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 Discussions, 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.


































