promptring
v1.0.4
Published
Native desktop notifications for GitHub Copilot CLI on macOS, Windows, Linux, and WSL.
Maintainers
Readme
promptring
Native desktop notifications for GitHub Copilot CLI when an agent finishes, needs input, or encounters a blocker.
Install
npm install -g promptringPrerequisites
- Node.js 18+
- Python 3
- macOS: Xcode Command Line Tools
- Linux:
notify-sendfor notification banners
The installer detects macOS, Windows, Linux, or WSL automatically and configures the Copilot CLI hooks. Restart Copilot CLI after installation.
Commands
promptring --check # Test the notification
promptring --mute # Mute the chime
promptring --unmute # Restore the chime
promptring --tring <file> # Use a custom sound
promptring --untring # Restore the default sound
promptring --status # Show the current sound configuration
promptring <category> [message]Supported categories are done, input, ready, blocked, and info.
For setup details, customization, troubleshooting, and uninstall instructions, see the full documentation.
MIT License
