https://github.com/developerhost/claude-beep
https://github.com/developerhost/claude-beep
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/developerhost/claude-beep
- Owner: developerhost
- Created: 2025-06-18T11:02:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-18T12:14:56.000Z (about 1 year ago)
- Last Synced: 2025-06-18T12:33:56.699Z (about 1 year ago)
- Language: TypeScript
- Size: 45.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Claude Beep 🔔
A wrapper for Claude Code that plays a beep sound when tasks complete, with cross-platform support for Mac, Windows, and Linux.
## Features
- 🔔 Plays beep sound when Claude Code tasks complete
- 🖥️ Desktop notifications (optional)
- 🌍 Cross-platform support (Mac, Windows, Linux)
- 📟 VSCode integrated terminal support
- 🍎 Native macOS beep via `osascript -e "beep"`
- 🪟 Native Windows beep via PowerShell `[Console]::Beep()`
- ⚙️ Configurable options (silent mode, no notifications)
- 🎵 Different sounds for success and error states
## Installation
### npm
```bash
npm install -g claude-beep
```
### Homebrew (Mac)
```bash
brew install claude-beep
```
### Scoop (Windows)
```bash
scoop install claude-beep
```
## Usage
Use `claude-beep` instead of `claude` to run Claude Code with beep notifications:
```bash
# Basic usage
claude-beep
# Pass arguments to Claude Code
claude-beep --help
claude-beep "write a hello world function"
# Silent mode (no beep)
claude-beep --silent
# Disable desktop notifications
claude-beep --no-notification
```
## Options
- `-s, --silent`: Disable beep sound
- `-n, --no-notification`: Disable desktop notification
- All other options are passed through to Claude Code
## Requirements
- Node.js 16 or higher
- Claude Code must be installed and available in PATH
## VSCode Setup
For VSCode users, enable terminal bell in settings:
```json
{
"terminal.integrated.enableBell": true
}
```
See [VSCode Setup Guide](docs/VSCODE_SETUP.md) for detailed instructions.
For more details on platform-specific sound implementations, see [Platform Sounds Guide](docs/PLATFORM_SOUNDS.md).
## Development
```bash
# Clone the repository
git clone https://github.com/your-username/claude-beep.git
cd claude-beep
# Install dependencies
pnpm install
# Run in development mode
pnpm dev
# Build for production
pnpm build
```
## License
MIT