ai-notify 0.2.1 → 0.2.2

package/README.ja.md

@@ -0,0 +1,121 @@
+# ai-notify
+
+[English](README.md) · **日本語**
+
+**ターミナルのAIエージェントが「あなたを必要とした瞬間」を逃さない** — Claude Code・Codex などのエージェントがターンを終えた／入力を求めた瞬間に、音・読み上げ・デスクトップ通知で知らせます。**全エージェント・全ターミナルを1つのスイッチで一括ミュート**。デーモンも常駐プロセスも無し。
+
+![ai-notify demo](https://raw.githubusercontent.com/unoryota/ai-notify/main/assets/hero-ja.gif)
+
+```sh
+npm i -g ai-notify
+ai-notify init        # インストール済みのエージェントを自動検出して配線
+```
+
+## 何が違うか
+
+エージェントは数分間も沈黙しがち。ai-notify は適切な瞬間に呼び戻します。とくに **AIを並列でたくさん動かす運用**のために作られています：
+
+- 🎙️ **ターミナルごとに声を変えられる。** ペインごとに別の声を割り当てれば、**どの窓が終わったか**を聞くだけで分かります — `export AI_NOTIFY_VOICE=Eddy`（または [VOICEVOX](#-voicevox-キャラクターボイス) のキャラ）。
+- 🌐 **あなたの言語で読み上げ。** エージェントの英語の返信・プロンプトを翻訳してから読み上げ／表示（キーレス・無料）。日本人にうれしい。
+- 📝 **「何をしたか」を教える。** 完了通知は「終わりました」だけでなく、エージェントの最後の返信（transcript）から作業内容を要約します。
+- 🔕 **1スイッチで全部ミュート。** 全エージェント・全ターミナルが同じフラグを読むので、会議中はワンタップで全部静かに。
+- 🔔 **ネイティブのメニューバーも内蔵。** `ai-notify menubar install` — Hammerspoon/SwiftBar 不要。
+
+## 対応エージェント
+
+| エージェント | 状態 | 配線方法 |
+| ----- | ------ | -------------- |
+| Claude Code | ✅ | `~/.claude/settings.json` の `Notification` + `Stop` フック |
+| Codex CLI | ✅ | `~/.codex/config.toml` の `notify`（`agent-turn-complete`） |
+| Gemini CLI | 🧪 検出のみ・フック作業中 | PR歓迎 |
+
+別のエージェント（aider, opencode, amp …）の追加は小さなPRで可能：`src/providers/` にファイルを1つ置くだけ。[CONTRIBUTING](CONTRIBUTING.md) 参照。
+
+## コマンド
+
+```sh
+ai-notify init [--dry-run] [--only claude,codex]   # 検出したエージェントを配線
+ai-notify toggle | on | off | status               # ミュートスイッチ
+ai-notify volume [0.0-2.0]                          # 音量の取得／設定
+ai-notify voice [number|name|preview|default]      # 読み上げ音声を選ぶ
+ai-notify voicevox [on <id>|off|speakers|test]     # VOICEVOXの声で読み上げ
+ai-notify translate [on <lang>|off|test]           # エージェントの文章を自分の言語で
+ai-notify menubar [install|uninstall|status]       # ネイティブのメニューバー（macOS）
+ai-notify doctor                                   # 依存・配線の確認
+ai-notify uninstall                                # 配線をきれいに削除
+```
+
+ペイン別の上書き — エージェントを起動する**前**に、その端末で `export` する：
+
+```sh
+AI_NOTIFY_LABEL=api               # この窓の読み上げ／通知での名前
+AI_NOTIFY_VOICE=Eddy              # この窓の `say` 音声
+AI_NOTIFY_VOICEVOX_SPEAKER=3      # この窓の VOICEVOX 話者ID
+AI_NOTIFY_VOLUME=0.5              # この窓の音量（0.0〜2.0）
+```
+
+## 🎛️ ネイティブのメニューバー — ミュート・音量・声
+
+エージェントが走っているターミナルにはコマンドを打てないので、**メニューバー**から全部操作します：
+
+```sh
+ai-notify menubar install   # ネイティブのメニューバーアプリ・ログイン時に自動起動
+```
+
+モノクロの波形アイコンが**状態を色で**表します（Adobe風）：通常はシルエットのみ、入力待ちがあると**黄ドット**、ミュート中は**赤＋斜線**。
+
+- **左クリック** → メニュー：**音量スライダー**、**声の一覧**（システム＋VOICEVOX）、**ペイン別**設定（開いている各ターミナルに個別の声と音量）。
+- **右クリック** → 即ミュート切替。
+
+第三者アプリ不要。別の方法が好みなら、**Hammerspoon**・**SwiftBar/xbar**・**Raycast**・標準の**ショートカット**用レシピが [`recipes/`](recipes/) にあります。`ai-notify status --icon` は `🔔`/`🔕` だけを出力するので、tmux・プロンプト・Claude Code のステータスラインに埋め込めます。
+
+> 切替は実行中でも効きます：次にエージェントが発火した時にフラグを読むので、トグルした瞬間に全稼働エージェントへ反映されます。
+
+## 🎙️ VOICEVOX キャラクターボイス
+
+通知を [VOICEVOX](https://voicevox.hiroshiba.jp/) のキャラ声（例：ずんだもん）で読み上げられます（無料・ローカル・オフライン）。
+
+> **VOICEVOXアプリのインストールと起動が必要です。** ai-notify はローカルのエンジンを叩くだけで、音声データは同梱していません。未起動なら ai-notify は**OS標準の音声**（Samantha, Kyoko …）を使います（こちらは設定不要ですぐ動きます）。
+
+`ai-notify voicevox setup` が案内します — ダウンロードページを開き、インストール済みならアプリを起動してエンジンの起動を待ちます。その後：
+
+```sh
+ai-notify voicevox setup        # VOICEVOXの導入／起動
+ai-notify voicevox speakers     # 利用可能なキャラとIDの一覧
+ai-notify voicevox on 3         # 話者3（例：ずんだもん）を使う
+```
+
+`AI_NOTIFY_VOICEVOX_SPEAKER` で各ペインに別キャラを割り当て可能。エンジンが起動していなければ自動でOS音声にフォールバックします。
+*VOICEVOXのキャラには利用規約があります。録画などを共有する場合は [VOICEVOXのガイドライン](https://voicevox.hiroshiba.jp/term/) に従ってクレジットしてください。*
+
+## 🌐 あなたの言語で読み上げ
+
+```sh
+ai-notify translate on ja       # エージェントのメッセージを翻訳してから読み上げ
+ai-notify translate test "I fixed the auth bug and added 3 tests."
+```
+
+キーレス・無料（HTTP 1リクエスト。オフライン時はローカルの定型文にフォールバック）。デスクトップ通知には原文も表示されます。
+
+## ⏳ どの窓が・何を求めているか
+
+各通知のタイトルに窓ラベルが付きます — 入力待ちは `⏳ <label>`、完了は `✓ <label>`。本文には**何を**（翻訳されたプロンプト、または作業内容の要約）が出ます。各ペインに短い `AI_NOTIFY_LABEL` を設定すれば、10個のターミナルもひと目で見分けられます。
+
+## 仕組み
+
+XDGパス配下の単一のミュートフラグと設定だけ — デーモンも調整も無し：
+
+```
+${XDG_STATE_HOME:-~/.local/state}/ai-notify/muted     # 存在＝ミュート
+${XDG_CONFIG_HOME:-~/.config}/ai-notify/config.json   # 音・声・各種オプション
+```
+
+各エージェントのフックが `ai-notify hook --source <agent>` を呼び、発火時にこの1つのフラグを読みます。`ai-notify config init` で編集可能な設定（エージェント別の音・声・TTSバックエンド・翻訳・テンプレート）を書き出せます。
+
+## 対応プラットフォーム
+
+macOS は完全対応（`afplay` / `say` / VOICEVOX / `terminal-notifier` / ネイティブメニューバー）。Linux はベストエフォート（`paplay`/`canberra`, `notify-send`, `spd-say`/`espeak`, VOICEVOX）。Windows はビープ＋PowerShell読み上げ。利用できないバックエンドは静かに縮退し、エラーにはなりません。
+
+## ライセンス
+
+[MIT](LICENSE)。ランタイム依存ゼロ。

package/README.md

@@ -1,8 +1,10 @@
 # ai-notify
 
+**English** · [日本語](README.ja.md)
+
 **Know the moment your terminal AI agent needs you** — a sound, a spoken read-out, and a desktop banner the instant Claude Code, Codex, or another agent finishes a turn or asks for input. One mute switch covers **all of them, across every terminal**. No daemon, no background process.
 
-![ai-notify demo](https://raw.githubusercontent.com/unoryota/ai-notify/main/assets/demo.gif)
+![ai-notify demo](https://raw.githubusercontent.com/unoryota/ai-notify/main/assets/hero-en.gif)
 
 ```sh
 npm i -g ai-notify
@@ -19,10 +21,6 @@ Plenty of agents go quiet for minutes. ai-notify pulls you back at the right mom
 - 🔕 **One switch mutes everything.** Every agent in every terminal reads the same flag — one tap silences them all for a meeting.
 - 🔔 **A real menu bar bell, built in.** `ai-notify menubar install` — no Hammerspoon/SwiftBar required.
 
-> ### 日本語
-> 複数のAIエージェント（Claude Code / Codex …）を**並列で動かすと、どのターミナルの通知か分からない**——を解決する通知ツール。
-> **ペインごとに声を変えられる**（VOICEVOXのキャラ声も）／**英語の出力を日本語に翻訳して読み上げ**／**完了通知に作業内容の要約**／**1タップで全部ミュート**（MTG用）／**メニューバーのベルも内蔵**。
-
 ## Supported agents
 
 | Agent | Status | How it's wired |
@@ -75,9 +73,14 @@ No third-party app needed. Prefer something else? There are drop-in recipes for
 
 ## 🎙️ VOICEVOX character voices
 
-Speak your notifications in [VOICEVOX](https://voicevox.hiroshiba.jp/) character voices (free, local, offline). Run the VOICEVOX app, then:
+Optionally speak your notifications in [VOICEVOX](https://voicevox.hiroshiba.jp/) character voices (e.g. ずんだもん) — free, local, offline.
+
+> **Needs the VOICEVOX app installed and running.** ai-notify calls its local engine; it does not bundle the voices. Without it, ai-notify just uses your OS voice (Samantha, Kyoko, …) — no setup required.
+
+`ai-notify voicevox setup` walks you through it — it opens the download page, or launches the app and waits for the engine if it's already installed. Then:
 
 ```sh
+ai-notify voicevox setup        # install / launch VOICEVOX
 ai-notify voicevox speakers     # list available characters + ids
 ai-notify voicevox on 3         # use speaker 3 (e.g. ずんだもん)
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-notify",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Desktop, sound, and spoken notifications for terminal AI coding agents (Claude Code, Codex, Gemini, ...) — with one mute switch that covers all of them, across every terminal.",
   "type": "module",
   "bin": {
@@ -15,6 +15,7 @@
     "menubar/README.md",
     "menubar/dist",
     "README.md",
+    "README.ja.md",
     "LICENSE"
   ],
   "scripts": {

package/src/cli.mjs

@@ -27,7 +27,7 @@ import {
   updatePaneSetting,
 } from './state.mjs';
 
-const VERSION = '0.2.1';
+const VERSION = '0.2.2';
 
 const args = process.argv.slice(2);
 const cmd = args[0];
@@ -253,6 +253,33 @@ const cmds = {
     const config = readConfig();
     const url = config.voicevox?.url || voicevox.DEFAULT_URL;
 
+    if (sub === 'setup') {
+      if (voicevox.isAvailable(url)) {
+        log('✓ VOICEVOX engine is already running.');
+        return log('Enable it:  ai-notify voicevox on    (list voices: ai-notify voicevox speakers)');
+      }
+      if (process.platform !== 'darwin') {
+        log(`VOICEVOX is not running. Install it from ${voicevox.DOWNLOAD_URL} and launch the app, then:`);
+        return log('  ai-notify voicevox on');
+      }
+      if (voicevox.appInstalled()) {
+        log('VOICEVOX is installed but not running. Launching it…');
+        voicevox.launchApp();
+        log('  Waiting for the engine to start (first launch can take ~30s)…');
+        if (voicevox.waitForEngine(url, 45000)) {
+          log('✓ engine ready.');
+          return log('Enable it:  ai-notify voicevox on');
+        }
+        return log('  Still starting. Once VOICEVOX is open, run:  ai-notify voicevox on');
+      }
+      log('VOICEVOX is not installed. Opening the download page…');
+      voicevox.openDownloadPage();
+      log('  1. Download the macOS app and move it to Applications.');
+      log('  2. First launch is Gatekeeper-blocked (it is open-source / unsigned):');
+      log('       xattr -dr com.apple.quarantine /Applications/VOICEVOX.app && open -a VOICEVOX');
+      log('  3. Then run:  ai-notify voicevox setup   (or  ai-notify voicevox on)');
+      return;
+    }
     if (sub === 'speakers') {
       const list = voicevox.listSpeakers(url);
       if (!list.length) return log(`No speakers (is VOICEVOX running at ${url}?).`);
@@ -524,7 +551,7 @@ Usage:
   ai-notify toggle | on | off | status               control the mute switch
   ai-notify volume [0.0-2.0]                          get/set output volume
   ai-notify voice [number|name|preview|default]      pick the spoken voice
-  ai-notify voicevox [on <id>|off|speakers|test]     speak in VOICEVOX character voices
+  ai-notify voicevox [setup|on <id>|off|speakers|test]  speak in VOICEVOX character voices
   ai-notify menubar [install|uninstall|status]       native menu bar bell (macOS)
   ai-notify translate [on <lang>|off|test]           speak agent text in your language
   ai-notify doctor                                    check deps & wiring

package/src/voicevox.mjs

@@ -11,13 +11,55 @@
 import { execSync, execFileSync } from 'node:child_process';
 import { existsSync, statSync, mkdtempSync, rmSync, appendFileSync } from 'node:fs';
 import { join } from 'node:path';
-import { tmpdir } from 'node:os';
+import { tmpdir, homedir } from 'node:os';
 import { stateDir } from './state.mjs';
 
 export const DEFAULT_URL = 'http://127.0.0.1:50021';
+export const DOWNLOAD_URL = 'https://voicevox.hiroshiba.jp/';
 
 const platform = process.platform;
 
+const sleep = (ms) => {
+  try {
+    Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, ms);
+  } catch {
+    /* SharedArrayBuffer unavailable — skip the wait */
+  }
+};
+
+// Is the VOICEVOX app installed (macOS)?
+export const appInstalled = () => {
+  if (platform !== 'darwin') return false;
+  return ['/Applications/VOICEVOX.app', join(homedir(), 'Applications/VOICEVOX.app')].some((p) => existsSync(p));
+};
+
+export const launchApp = () => {
+  try {
+    if (platform === 'darwin') execFileSync('open', ['-a', 'VOICEVOX']);
+  } catch {
+    /* ignore */
+  }
+};
+
+export const openDownloadPage = () => {
+  try {
+    if (platform === 'darwin') execFileSync('open', [DOWNLOAD_URL]);
+    else if (platform === 'linux') execFileSync('xdg-open', [DOWNLOAD_URL]);
+  } catch {
+    /* ignore */
+  }
+};
+
+// Poll until the engine answers, or timeout.
+export const waitForEngine = (url = DEFAULT_URL, timeoutMs = 40000) => {
+  const start = Date.now();
+  while (Date.now() - start < timeoutMs) {
+    if (isAvailable(url, 1500)) return true;
+    sleep(2000);
+  }
+  return false;
+};
+
 // Record why a synthesis fell back to the OS voice, so intermittent fallbacks
 // are diagnosable instead of silent. Best-effort.
 const logFail = (reason) => {