Skip to content

al3xjohnson/herald

Repository files navigation

Herald

Herald

GitHub release CI License Node version

Configurable notifications for Claude Code
TTS or alert sounds — you choose.


Features

  • Text-to-Speech — Hear a summary of Claude's response when it finishes
  • Alert Sounds — Play a sound and bring your editor/terminal to focus
  • Cross-Platform — Works on macOS and Windows
  • Swappable TTS Providers — Built-in macOS/Windows speech, or use ElevenLabs for premium voices

Installation

Run these commands in Claude Code:

/plugin install al3xjohnson/herald/plugin
/herald:style tts

Commands

Command Description
/herald:enable Enable notifications
/herald:disable Disable notifications
/herald:status Show current configuration
/herald:style <tts|alerts> Set notification style
/herald:preferences Configure TTS settings (max words, custom prompts, editor activation)
/herald:tts Configure TTS provider

Notification Styles

  • tts — Text-to-speech reads a summary of the response, then activates your window
  • alerts — Plays a sound and activates your window

Both modes automatically detect where Claude Code is running and activate the correct app:

  • VS Code — When running in the integrated terminal
  • Ghostty, iTerm, Terminal.app, Alacritty, Kitty, WezTerm, Hyper — When running in a terminal
  • Windows Terminal — Detected via WT_SESSION

Disable window activation with /herald:preferences activate_editor off.

Use /herald:disable to turn off notifications entirely.

TTS Providers

Provider Platform Setup
macos macOS Built-in, no setup needed
windows Windows Built-in, no setup needed
elevenlabs Any Requires API key and voice ID

Using ElevenLabs

/herald:tts provider elevenlabs
/herald:tts elevenlabs api_key YOUR_API_KEY
/herald:tts elevenlabs voice_id YOUR_VOICE_ID

Configuration

Herald stores its configuration in ~/.config/herald/config.json:

{
  "enabled": true,
  "style": "tts",
  "tts": {
    "provider": "macos"
  },
  "preferences": {
    "max_words": 50,
    "summary_prompt": null,
    "activate_editor": true
  }
}

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines on:

  • Development setup
  • Code quality standards
  • Testing requirements
  • Pull request process

Security

For security concerns, please review SECURITY.md for:

  • Reporting vulnerabilities
  • Security best practices
  • Supported versions

License

MIT

About

Audio notifications for Claude Code - TTS summaries or alert sounds

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors 6