OpenCode plugin that plays sounds and sends system notifications when permission is needed, generation completes, or errors occur. Works on macOS, Linux, and Windows.
Add the plugin to your opencode.json or opencode.jsonc:
{
"plugin": ["@mohak34/opencode-notifier"]
}Restart OpenCode. The plugin will be automatically installed and loaded.
The plugin works out of the box on all platforms. For best results:
- macOS: No additional setup required
- Windows: No additional setup required
- Linux: For sounds, one of these should be installed:
paplay,aplay,mpv, orffplay. For notifications,notify-sendis recommended.
To customize the plugin, create ~/.config/opencode/opencode-notifier.json:
{
"sound": true,
"notification": true,
"timeout": 5,
"events": {
"permission": { "sound": true, "notification": true },
"complete": { "sound": true, "notification": true },
"error": { "sound": true, "notification": true }
},
"messages": {
"permission": "OpenCode needs permission",
"complete": "OpenCode has finished",
"error": "OpenCode encountered an error"
},
"sounds": {
"permission": "/path/to/custom/sound.wav",
"complete": "/path/to/custom/sound.wav",
"error": "/path/to/custom/sound.wav"
}
}| Option | Type | Default | Description |
|---|---|---|---|
sound |
boolean | true |
Global toggle for all sounds |
notification |
boolean | true |
Global toggle for all notifications |
timeout |
number | 5 |
Notification duration in seconds (Linux only) |
Control sound and notification separately for each event:
{
"events": {
"permission": { "sound": true, "notification": true },
"complete": { "sound": false, "notification": true },
"error": { "sound": true, "notification": false }
}
}Or use a boolean to toggle both:
{
"events": {
"permission": true,
"complete": false,
"error": true
}
}Customize notification text:
{
"messages": {
"permission": "Action required",
"complete": "Done!",
"error": "Something went wrong"
}
}Use your own sound files:
{
"sounds": {
"permission": "/home/user/sounds/alert.wav",
"complete": "/home/user/sounds/done.wav",
"error": "/home/user/sounds/error.wav"
}
}If a custom sound file path is provided but the file doesn't exist, the plugin will fall back to the bundled sound.
MIT