Package Exports

claude-code-notify-lite
claude-code-notify-lite/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (claude-code-notify-lite) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Claude Code Notify Lite

Task completion notifications for Claude Code - Cross-platform, lightweight, and easy to use.

English | 中文

Features

Cross-platform - Works on Windows, macOS, and Linux
Lightweight - Minimal dependencies, fast startup
Easy to use - One command installation
Customizable - Choose your notification sound
Non-intrusive - Integrates seamlessly with Claude Code

Quick Start

Using npm (Recommended)

npm install -g claude-code-notify-lite
ccnotify install

Using install script

macOS / Linux:

curl -fsSL https://raw.githubusercontent.com/waterpen6/claude-code-notify-lite/main/scripts/install.sh | bash

Windows (PowerShell):

iwr -useb https://raw.githubusercontent.com/waterpen6/claude-code-notify-lite/main/scripts/install.ps1 | iex

Usage

After installation, notifications will automatically appear when Claude Code completes a task.

Commands

# Test notification
ccnotify test

# Check installation status
ccnotify status

# Configure settings interactively
ccnotify config

# List available sounds
ccnotify sounds

# Uninstall
ccnotify uninstall

Configuration

Configuration file location:

Windows: %APPDATA%\claude-code-notify-lite\config.json
macOS: ~/Library/Application Support/claude-code-notify-lite/config.json
Linux: ~/.config/claude-code-notify-lite/config.json

Options

{
  "notification": {
    "enabled": true,
    "title": "Claude Code",
    "showWorkDir": true,
    "showTime": true
  },
  "sound": {
    "enabled": true,
    "file": "default",
    "volume": 80
  }
}

Custom Sound

You can use a custom sound file:

{
  "sound": {
    "file": "/path/to/your/sound.mp3"
  }
}

Supported formats: MP3, WAV, M4A, OGG

How It Works

Claude Code Notify Lite integrates with Claude Code's hook system:

When you run ccnotify install, it adds a Stop hook to your Claude Code settings
When Claude Code completes a task, it triggers the hook
The hook sends a system notification and plays a sound

Troubleshooting

Notification not showing

macOS:

Go to System Settings > Notifications
Find "Terminal" (or your terminal app) and enable notifications

Windows:

Go to Settings > System > Notifications
Ensure notifications are enabled

Sound not playing

Check system volume
Verify the sound file exists: ccnotify sounds
Try a different sound: ccnotify config

Hook not working

# Check installation status
ccnotify status

# Reinstall if needed
ccnotify uninstall
ccnotify install

Uninstall

ccnotify uninstall
npm uninstall -g claude-code-notify-lite

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT