Metadata-Version: 2.4
Name: claude-code-notify
Version: 1.0.2
Summary: Desktop notifications for Claude Code - get notified when tasks complete
Project-URL: Homepage, https://github.com/starpipi/claude-code-notify
Project-URL: Repository, https://github.com/starpipi/claude-code-notify
Project-URL: Issues, https://github.com/starpipi/claude-code-notify/issues
Author: starpipi
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: claude,claude-code,desktop,linux,macos,notifications,windows
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
Requires-Dist: pytest>=7.0.0; extra == 'test'
Description-Content-Type: text/markdown

# claude-code-notify

English | [中文](./README_CN.md)

Desktop notifications for [Claude Code](https://docs.anthropic.com/en/docs/claude-code) - get notified when tasks complete, when permission is needed, or when Claude is waiting for input.

## Features

- **Task Completion Notifications**: Get notified when Claude finishes a task, with a preview of the response
- **Permission Prompts**: Know immediately when Claude needs your approval
- **Idle Prompts**: Get alerted when Claude is waiting for your input
- **Cross-Platform**: Works on macOS, Windows, and Linux

## Installation

### Option 1: pip/uv install (Recommended)

```bash
pip install git+https://github.com/starpipi/claude-code-notify.git
```

Or with [uv](https://github.com/astral-sh/uv):

```bash
uv tool install git+https://github.com/starpipi/claude-code-notify.git
```

Then add to `~/.claude/settings.json`:

```json
{
  "hooks": {
    "Stop": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "claude-code-notify"
          }
        ]
      }
    ],
    "Notification": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "claude-code-notify"
          }
        ]
      }
    ]
  }
}
```

### Option 2: Claude Code Plugin

Clone the repository to the plugins marketplace directory:

```bash
git clone https://github.com/starpipi/claude-code-notify.git ~/.claude/plugins/marketplaces/claude-code-notify
```

Then enable the plugin in `~/.claude/settings.json`:

```json
{
  "enabledPlugins": {
    "notify@claude-code-notify": true
  }
}
```

## Platform Requirements

### macOS
No additional setup needed. Uses native `osascript`.

### Windows
No additional setup needed. Uses PowerShell with Windows Forms.

### Linux
Requires `libnotify`:

```bash
# Debian/Ubuntu
sudo apt install libnotify-bin

# Fedora
sudo dnf install libnotify

# Arch
sudo pacman -S libnotify
```

## Manual Testing

Test notifications directly from the command line:

```bash
# If installed via pip/uv
claude-code-notify "Test Title" "Test message body"

# If installed via plugin
python3 ~/.claude/plugins/marketplaces/claude-code-notify/plugin/hooks/notify.py "Test" "Hello"
```

## Debug Logs

Debug logs are written to `/tmp/claude_code_notify_debug.log` for troubleshooting.

## License

Apache-2.0
