vibe-notify 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.ja.md ADDED
@@ -0,0 +1,112 @@
1
+ # vibe-notify 🔊
2
+
3
+ Claude Code セッションの通知音。Claude の応答が完了したときにカスタマイズ可能なビープ音/ジングルを再生します。席を離れていてもタスクの完了がわかります。
4
+
5
+ ## クイックスタート
6
+
7
+ ```bash
8
+ # グローバルにインストール
9
+ npm install -g vibe-notify
10
+
11
+ # テスト
12
+ vibe-notify victory
13
+
14
+ # 設定ファイルを作成
15
+ vibe-notify --init
16
+ ```
17
+
18
+ インストールなしでも実行できます:
19
+
20
+ ```bash
21
+ npx -y vibe-notify victory
22
+ ```
23
+
24
+ ## 内蔵サウンド
25
+
26
+ | サウンド | 説明 |
27
+ |-------|-------------|
28
+ | `short-beep` | 短いビープ音 — クイック確認 |
29
+ | `double-beep` | 2回の短いビープ音 — 「処理が完了しました」 |
30
+ | `ascending` | 3つの上昇音 — ポジティブな進行 |
31
+ | `descending` | 3つの下降音 — タスク完了、落ち着く |
32
+ | `victory` | C-E-G-C アルペジオ — 勝利のジングル |
33
+ | `custom` | 自分の `.wav` ファイルを再生 |
34
+
35
+ いつでも一覧表示:`vibe-notify --list`
36
+
37
+ ## 設定
38
+
39
+ 設定ファイルの場所(優先順):
40
+ 1. **プロジェクトローカル**:プロジェクトルートの `.vibe-notify.json`
41
+ 2. **グローバル**:`~/.vibe-notify/config.json`
42
+
43
+ ```json
44
+ {
45
+ "sound": "ascending",
46
+ "customFile": null,
47
+ "volume": 0.7,
48
+ "playback": {
49
+ "method": "auto"
50
+ }
51
+ }
52
+ ```
53
+
54
+ ### カスタムサウンドファイル
55
+
56
+ ```json
57
+ {
58
+ "sound": "custom",
59
+ "customFile": "C:\\Users\\You\\sounds\\done.wav",
60
+ "volume": 1.0
61
+ }
62
+ ```
63
+
64
+ ## Claude Code フック設定
65
+
66
+ Claude の応答完了時に自動再生するには、`.claude/settings.json`(プロジェクトまたはグローバル)に以下を追加します:
67
+
68
+ ```json
69
+ {
70
+ "hooks": {
71
+ "Stop": [
72
+ {
73
+ "hooks": [
74
+ {
75
+ "type": "command",
76
+ "command": "npx",
77
+ "args": ["-y", "vibe-notify"],
78
+ "timeout": 15
79
+ }
80
+ ]
81
+ }
82
+ ]
83
+ }
84
+ }
85
+ ```
86
+
87
+ グローバルインストールしている場合は `"npx", "-y", "vibe-notify"` を `"vibe-notify"` に置き換えてください。args にサウンド名(例:`"victory"`)を追加すると設定ファイルの設定を上書きできます。
88
+
89
+ ## CLI リファレンス
90
+
91
+ ```
92
+ vibe-notify [options] [sound-name]
93
+
94
+ オプション:
95
+ --help, -h ヘルプを表示
96
+ --list, -l 利用可能なサウンドを一覧表示
97
+ --config, -c 設定ファイルのパスを表示
98
+ --init デフォルト設定ファイルを作成
99
+ --version, -v バージョンを表示
100
+ ```
101
+
102
+ ## 仕組み
103
+
104
+ - **ランタイム依存ゼロ** — すべてのサウンド生成は純粋な Node.js で行います
105
+ - 内蔵サウンドは WAV オーディオとしてメモリ上で生成(エンベロープ付き正弦波)
106
+ - 再生にはネイティブシステムプレイヤーを使用:PowerShell SoundPlayer (Windows)、afplay (macOS)、paplay/aplay (Linux)
107
+ - WAV 再生に失敗した場合は `[System.Console]::Beep()` または端末ベルにフォールバック
108
+ - 一時ファイルは再生後すぐにクリーンアップ
109
+
110
+ ## ライセンス
111
+
112
+ MIT
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # vibe-notify 🔊
2
2
 
3
+ [English](./README.md) | [中文](./README.zh-CN.md) | [日本語](./README.ja.md)
4
+
3
5
  Notification sounds for Claude Code sessions. Plays a customizable beep/jingle when Claude finishes responding — so you can step away and still know when your task is done.
4
6
 
5
7
  ## Quick Start
@@ -0,0 +1,112 @@
1
+ # vibe-notify 🔊
2
+
3
+ Claude Code 会话的通知提示音。当 Claude 完成响应时播放可自定义的提示音/铃声 — 让你可以走开也能知道任务已完成。
4
+
5
+ ## 快速开始
6
+
7
+ ```bash
8
+ # 全局安装
9
+ npm install -g vibe-notify
10
+
11
+ # 测试一下
12
+ vibe-notify victory
13
+
14
+ # 创建配置文件
15
+ vibe-notify --init
16
+ ```
17
+
18
+ 或者无需安装直接运行:
19
+
20
+ ```bash
21
+ npx -y vibe-notify victory
22
+ ```
23
+
24
+ ## 内置音效
25
+
26
+ | 音效 | 描述 |
27
+ |-------|-------------|
28
+ | `short-beep` | 一声短促提示音 — 快速确认 |
29
+ | `double-beep` | 两声短促提示音 — "任务完成了" |
30
+ | `ascending` | 三声渐高音调 — 正向进展 |
31
+ | `descending` | 三声渐低音调 — 任务完成,放松下来 |
32
+ | `victory` | C-E-G-C 琶音 — 庆祝胜利 |
33
+ | `custom` | 播放你自己的 `.wav` 文件 |
34
+
35
+ 随时查看音效列表:`vibe-notify --list`
36
+
37
+ ## 配置
38
+
39
+ 配置文件位置(按顺序查找):
40
+ 1. **项目本地**:项目根目录下的 `.vibe-notify.json`
41
+ 2. **全局**:`~/.vibe-notify/config.json`
42
+
43
+ ```json
44
+ {
45
+ "sound": "ascending",
46
+ "customFile": null,
47
+ "volume": 0.7,
48
+ "playback": {
49
+ "method": "auto"
50
+ }
51
+ }
52
+ ```
53
+
54
+ ### 自定义音频文件
55
+
56
+ ```json
57
+ {
58
+ "sound": "custom",
59
+ "customFile": "C:\\Users\\You\\sounds\\done.wav",
60
+ "volume": 1.0
61
+ }
62
+ ```
63
+
64
+ ## Claude Code Hook 设置
65
+
66
+ 将以下内容添加到 `.claude/settings.json`(项目或全局),在 Claude 完成响应时自动播放:
67
+
68
+ ```json
69
+ {
70
+ "hooks": {
71
+ "Stop": [
72
+ {
73
+ "hooks": [
74
+ {
75
+ "type": "command",
76
+ "command": "npx",
77
+ "args": ["-y", "vibe-notify"],
78
+ "timeout": 15
79
+ }
80
+ ]
81
+ }
82
+ ]
83
+ }
84
+ }
85
+ ```
86
+
87
+ 如果已全局安装,将 `"npx", "-y", "vibe-notify"` 替换为 `"vibe-notify"`。在 args 中添加音效名称(如 `"victory"`)可覆盖配置文件中的设置。
88
+
89
+ ## CLI 参考
90
+
91
+ ```
92
+ vibe-notify [options] [sound-name]
93
+
94
+ 选项:
95
+ --help, -h 显示帮助
96
+ --list, -l 列出可用音效
97
+ --config, -c 打印配置文件路径
98
+ --init 创建默认配置文件
99
+ --version, -v 显示版本
100
+ ```
101
+
102
+ ## 工作原理
103
+
104
+ - **零运行时依赖** — 所有音频均使用纯 Node.js 生成
105
+ - 内置音效以 WAV 格式在内存中生成(带包络的正弦波)
106
+ - 播放使用系统原生播放器:PowerShell SoundPlayer (Windows)、afplay (macOS)、paplay/aplay (Linux)
107
+ - 如果 WAV 播放失败,回退到 `[System.Console]::Beep()` 或终端响铃
108
+ - 临时文件在播放后立即清理
109
+
110
+ ## 许可证
111
+
112
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vibe-notify",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Notification sounds for Claude Code completions — customizable beeps when your session finishes",
5
5
  "keywords": ["claude", "claude-code", "notification", "sound", "beep", "alert"],
6
6
  "license": "MIT",
@@ -14,6 +14,8 @@
14
14
  "files": [
15
15
  "dist/",
16
16
  "README.md",
17
+ "README.zh-CN.md",
18
+ "README.ja.md",
17
19
  "LICENSE"
18
20
  ],
19
21
  "scripts": {