イベント一覧

gate は戻り値で拒否や中止ができるイベント（.catch を付けるか検討すべきイベント）、stream は async generator で書くイベントを表します。「next(e) の結果」の欄は、そのイベントのフックが返す値と同じ形です。

ツール

プロンプト

UI

セッション

ターン・エージェント

コマンド・設定・プラグイン・テレメトリ

ストリーミングイベント

turn.step と process.spawn の2つのイベントだけは、フックを async function* で書きます（この形で書かないと読み込まれません）。next(e) は後続の処理のストリームを返します。

// 他のプラグインが起動した子プロセスの出力から、トークンを伏せ字にする
on('process.spawn', async function* ($, e, next) {
  for await (const chunk of next(e)) {
    yield { ...chunk, text: chunk.text.replaceAll(token, '***') }
  }
})

• yield* next(e) と書くとストリームをそのまま後続に渡し、式の値が結果になる。
• for await を使うと、チャンクを1つずつ書き換えられる。next を使わずに yield すれば、フック自身が出力を生成する。
• 途中で失敗したフックは、失敗した時点の状態のまま残される。

classic.*（設定フックのイベント）

settings.json に書くコマンドフックのイベントも、classic.<Event> という名前でフックできます。e には、コマンドフックが標準入力で受け取る内容がすべて入ります（transcript_path や cwd などの共通フィールドを含みます）。ただし classic.PreToolUse の e は、ツール呼び出しの入力（ToolCallEnvelope）だけです。チェーンの順序は、managed の設定フック、フックモジュール、その他の設定フック（core）の順になります。

$ の呼び出しによるイベント

$.<名前空間>.<メソッド>(…) を呼び出すと、同じ名前のイベントが発生します。たとえば別のプラグインが $.fs.write を呼ぶと、チェーンの外側にあるフックからは fs.write イベントとして見え、書き換えや拒否ができます。呼び出したフック自身はスキップされます（同じプラグインの他のフックには届きます）。

$.state の値を書き込めるのは、その値を持つプラグインだけです。他のプラグインの値を変更したい場合は、state.set を plugin と key のマッチャーでフックし、next に別の value を渡します。