Tmux Alert
Tmux alert plugin for OpenCode — get notified when your AI agent needs attention
0
488
486 in 7 days
36.5
Multi-signal model
3 days ago
2026-10-17
Install and configure
opencode.jsonWrites to this project's opencode.json — applies to this repository only.
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-tmux-alert@1.0.1"]
}Writes to ~/.config/opencode/opencode.json — applies to every project.
~/.config/opencode/opencode.json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-tmux-alert@1.0.1"]
}If you want to modify the plugin locally, install it into the project and reference the local path.
shell
pnpm add -D opencode-tmux-alertOpenCode loads npm dependencies through its embedded runtime on startup and caches them locally — no manual global install needed.
opencode-tmux-alert
Tmux alert plugin for OpenCode. Get notified when your AI agent needs attention.
Quick Start
Package
Install in your OpenCode config directory:
bun install opencode-tmux-alert
Then add the plugin to your opencode.json:
{
"plugins": ["opencode-tmux-alert"]
}
Requires OpenCode V2.
How It Works
When OpenCode needs your attention (a task finishes, a permission is requested, or a question is asked), the plugin triggers a tmux alert on the current window. When you respond, the alert clears automatically.
The bundled scripts do two things:
- Set a tmux user option (
@opencode-alert) that you can reference in your status line - Send a bell character (
\a) which triggers tmux's built-inmonitor-bellnotification
This means alerts work out of the box with a standard tmux config, and can be further customised with status line formatting.
Events
| Event | Trigger | Action |
|---|---|---|
session.idle |
Task completed, agent waiting | Alert |
permission.asked |
Agent needs permission to proceed | Alert |
session.tool.called (not executed) |
Tool pending approval | Alert |
tui.prompt.append |
Agent asking a question | Alert |
session.inbox.enqueued (user) |
User submits a message | Clear |
Customisation
Status line indicator
Use the @opencode-alert user option in your tmux status format to show a visual indicator:
# In tmux.conf, show an indicator when OpenCode needs attention
set -g status-right "#{?@opencode-alert,#[fg=yellow] OpenCode,} ..."
Custom scripts
Override the bundled alert and clear scripts with your own via environment variables:
export OPENCODE_ALERT_SCRIPT="$HOME/my-scripts/alert.sh"
export OPENCODE_CLEAR_SCRIPT="$HOME/my-scripts/clear.sh"
Your scripts receive no arguments. The TMUX_PANE environment variable is available if you need to target the current window.
tmux bell monitoring
To use the bell-based alerts, enable monitoring in your tmux.conf:
set -g monitor-bell on
set -g visual-bell off # optional, suppress the visual flash
Requirements
Licence
Similar plugins
Simple Notify
opencode-simple-notify
Desktop notification plugin for OpenCode - works on Linux (dbus) and macOS (osascript)
Alert
@chousyn/opencode-alert
Cross-platform notification plugin for OpenCode — desktop alerts, sound alerts, and webhook notifications with project-level configuration
Notification
opencode-notification
OpenCode plugin for simple system notifications when permissions are needed, generation completes, or errors occur