Skip to content

Commit 618d13c

Browse files
authored
docs: add agent support matrix table to README (#37)
Replace scattered agent references with a single support matrix showing icon, auto-detect, --install support, hook type, and config location for all known CLI agents with published hook mechanisms.
1 parent db3bd4d commit 618d13c

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,27 @@ Options:
3131
--dry-run Show what would happen without executing side effects
3232
```
3333

34-
## AI CLI Auto-Detection
34+
## Supported AI Agents
3535

36-
Toasty automatically detects when it's called from a known AI CLI tool and applies the appropriate icon and title. No flags needed!
36+
| Agent | Icon | Auto-Detect | `--install` | Hook Type | Config Location |
37+
|-------|:----:|:-----------:|:-----------:|-----------|-----------------|
38+
| Claude Code |||| `Stop` | `~/.claude/settings.json` |
39+
| GitHub Copilot |||| `sessionEnd` | `.github/hooks/toasty.json` |
40+
| Gemini CLI |||| `AfterAgent` | `~/.gemini/settings.json` |
41+
| OpenAI Codex |||| `notify` | `~/.codex/config.toml` |
42+
| OpenCode |||| JS plugin | `~/.config/opencode/plugins/` |
43+
44+
- **Icon**: Built-in icon for toast notifications
45+
- **Auto-Detect**: Toasty recognizes the agent's process and applies the preset automatically
46+
- **`--install`**: `toasty --install` can automatically configure the agent's hook
47+
48+
Agents without `--install` support can still use toasty manually: `toasty "Task done" --app codex`
49+
50+
> Don't see your agent? Any CLI tool with a hook/notification mechanism can call toasty directly.
3751
38-
**Auto-detected tools:**
39-
- Claude Code
40-
- GitHub Copilot
41-
- Google Gemini CLI
52+
## Auto-Detection
53+
54+
Toasty automatically detects when it's called from a known AI CLI tool and applies the appropriate icon and title. No flags needed!
4255

4356
```cmd
4457
# Called from Claude - automatically uses Claude preset
@@ -64,14 +77,6 @@ Toasty can automatically configure AI CLI agents to show notifications when task
6477

6578
> 📖 **Want more control?** See [HOOKS.md](HOOKS.md) for all available hook events (permission requests, errors, session lifecycle, etc.)
6679
67-
### Supported Agents
68-
69-
| Agent | Config Path | Hook Event | Scope |
70-
|-------|-------------|------------|-------|
71-
| Claude Code | `~/.claude/settings.json` | `Stop` | User |
72-
| Gemini CLI | `~/.gemini/settings.json` | `AfterAgent` | User |
73-
| GitHub Copilot | `.github/hooks/toasty.json` | `sessionEnd` | Repo |
74-
7580
### Auto-Install
7681

7782
```cmd

0 commit comments

Comments
 (0)