Skip to content

README.zh-CN.md

Latest commit

 

History

History
87 lines (60 loc) · 2.36 KB

README.zh-CN.md

File metadata and controls

87 lines (60 loc) · 2.36 KB
Raw

Claude Code Notify

Claude Code 桌面通知插件 — 跨平台支持 Windows / macOS / Linux。

English

安装

两条命令，安装即用：

# 1. 添加插件源
/plugin marketplace add ferrymo/claude-code-notify

# 2. 安装插件
/plugin install claude-code-notify@claude-code-notify

安装后首次启动 Claude Code 时，SessionStart 钩子会自动：

  • 安装 BurntToast 模块（Windows）
  • 生成默认通知图标
  • 检查系统通知工具（macOS/Linux）

无需手动运行任何额外脚本，开箱即用。

触发机制

钩子 场景 通知类型
Stop Claude 完成任务/空闲 info
Notification + permission_prompt Claude 需要审批 warning
StopFailure Claude 执行出错 error

依赖

插件会自动处理，仅供参考：

  • Windows: PowerShell 7 (pwsh) + BurntToast（自动安装）
  • macOS: osascript（系统自带）；可选 terminal-notifier（brew install terminal-notifier，支持自定义图标）
  • Linux: notify-send（sudo apt install libnotify-bin）

自定义头像

将 PNG 图片（建议 256x256）替换到：

~/.claude/notify-icon.png

默认是一个自动生成的黑白像素风格图标，直接覆盖即可。

通知效果

  • Windows: Toast 通知，带自定义头像和声音
  • macOS: 原生通知中心弹窗（terminal-notifier 支持头像）
  • Linux: notify-send 桌面通知（支持头像和 urgency 级别）

每条通知包含：项目名 + git 分支、终端类型、Claude 消息摘要。

插件结构

claude-code-notify/
├── .claude-plugin/
│   ├── plugin.json          # 插件元数据
│   └── marketplace.json     # marketplace 注册
├── hooks/
│   └── hooks.json           # Claude Code 自动加载的 hooks 定义
├── setup.cmd / setup.ps1    # SessionStart 自动初始化（依赖+图标）
├── run-hook.cmd             # Windows hook 入口
├── run-hook.sh              # Unix hook 入口
├── notify.ps1               # Windows 通知核心（BurntToast）
├── notify.sh                # macOS/Linux 通知核心
└── README.md

卸载

/plugin uninstall claude-code-notify@claude-code-notify

图标文件 ~/.claude/notify-icon.png 会保留，可手动删除。

License

MIT