Cmux Using

send の改行ルール

これは最も重要なルールである。

単一行コマンド: \n で OK

cmux send --surface surface:1 "echo hello\n"

末尾の \n が Enter キーとして機能する。

複数行テキスト: send-key return が必須

\n は改行として送信されない。各行を個別に送り、行間で send-key return を使う。

# ✅ 正しい方法
cmux send --surface surface:1 "line 1"
cmux send-key --surface surface:1 return
cmux send --surface surface:1 "line 2"
cmux send-key --surface surface:1 return

# ❌ 間違い — \n は途中改行にならない
cmux send --surface surface:1 "line 1\nline 2\n"

ルール: 末尾の \n 1個だけは Enter として機能する。文字列の途中に \n を入れても改行にはならない。

制御キーの送信

プロセス中断（Ctrl+C）などの制御キーは send-key で送る。send では送れない。

# ✅ 正しい方法
cmux send-key --surface surface:N ctrl+c

# ❌ 間違い — リテラルテキストが送られるだけ
cmux send --surface surface:N "C-c"
cmux send --surface surface:N "\x03"
cmux send-key --surface surface:N "C-c"   # → Unknown key エラー

キー名は ctrl+c, ctrl+d, ctrl+z, return, tab, escape 等。send-key --help で確認可能。

cross-workspace 操作の注意（重要）

別ワークスペースのサーフェスを操作する場合、--surface ではなく --workspace を使う。

# ✅ 正しい方法 — --workspace で指定（focused surface に自動解決）
cmux send --workspace workspace:N "command\n"
cmux read-screen --workspace workspace:N
cmux send-key --workspace workspace:N return

# ❌ 間違い — --surface で他ワークスペースのサーフェスを指定
cmux send --surface surface:S "command\n"        # → "Surface is not a terminal" エラー
cmux read-screen --surface surface:S             # → 同上

理由: --surface は caller と同一ワークスペース内のサーフェスのみ有効。他ワークスペースのサーフェスを指定すると CLI は "Surface is not a terminal" エラーを返す。--workspace はワークスペースの focused surface に自動解決され、cross-workspace でも正しく動作する。

ペイン再利用の原則

新しいペイン/ワークスペースを作る前に、ユーザーが clear 済みの遊休ペインを探して再利用する。

cmux list-pane-surfaces                          # 全サーフェス一覧
screen=$(cmux read-screen --surface surface:N)   # 各サーフェスの状態を確認
# シェルプロンプト（$ や ❯）のみ → 遊休 → 再利用可能

遊休ペインがなければ通常通り new-split / new-workspace で作成する。

サブエージェント操作パターン

サブエージェントを起動し、タスクを委任し、結果を回収する一連の手順。

配置方式の選択

Step 1a: 同一ワークスペースに配置（推奨）

SURF=$(cmux new-split right | awk '{print $2}')
cmux rename-tab --surface $SURF "Researcher-1"

Step 1b: 別ワークスペースに配置

WS=$(cmux new-workspace --cwd $(pwd) | awk '{print $2}')
cmux rename-workspace --workspace $WS "Researcher-1"

注意: PTY 遅延初期化問題（後述）により、ワークスペースを GUI 上で一度表示する必要がある場合がある。

Step 2: Claude Code 起動

cmux send --workspace $WS "claude --dangerously-skip-permissions\n"

--dangerously-skip-permissions は信頼できるタスクにのみ使うこと。

Step 3: Trust 検出 → 承認

起動直後に Trust 確認プロンプトが表示される場合がある。read-screen でポーリングし、"trust" や "Yes, I trust" を検出したら承認:

screen=$(cmux read-screen --workspace $WS)
# "trust" 検出 → 承認
cmux send-key --workspace $WS return

Step 4: 起動完了の検出

❯ プロンプトが表示されるまで read-screen --workspace $WS でポーリング。

Step 5: プロンプト送信

# 単一行
cmux send --workspace $WS "指示テキスト\n"
cmux set-status $WS "調査中" --icon hammer  # ステータスを設定

# 複数行（send-key return で改行）
cmux send --workspace $WS "1行目の指示"
cmux send-key --workspace $WS return
cmux send --workspace $WS "2行目の指示"
cmux send-key --workspace $WS return

Step 6: 完了検出

❯ プロンプトの再表示を read-screen --workspace $WS でポーリングして検出。

Step 7: 結果回収 & クリーンアップ

cmux clear-status $WS                                      # ステータスをクリア
result=$(cmux read-screen --workspace $WS --scrollback)  # 全出力取得

# クリーンアップ: Claude 終了 → ペイン閉じ
cmux send --workspace $WS "/exit\n"
sleep 2
cmux close-workspace --workspace $WS                      # ワークスペースごと閉じる

重要: /exit だけでは Claude プロセスが終了するだけでペイン（surface）は残る。必ず close-workspace（または close-surface）でペインも閉じること。sleep 2 は /exit の処理完了を待つため。

new-workspace の PTY 遅延初期化問題（Issue #1472）

cmux new-workspace で作成したワークスペースのターミナル PTY は、GUI 上で一度表示されるまで起動しない。 select-workspace API だけでは不十分で、GUI 描画（SwiftUI レンダリング）が必要。

症状

• cmux send --surface surface:N → OK を返すがコマンドは実行されない（キューに留まる）
• cmux read-screen --surface surface:N → Surface is not a terminal エラー
• ソケット API surface.send_text → queued: true だが未配信
• ソケット API surface.read_text → Terminal surface not found

ワークアラウンド: AppleScript メニュークリック

macOS アクセシビリティ許可が必要（システム設定 → プライバシーとセキュリティ → アクセシビリティ）。

# ワークスペース作成後に GUI 表示を強制する
WS=$(cmux new-workspace --cwd $(pwd) | awk '{print $2}')

# ワークスペースのインデックスを取得
WS_INDEX=$(cmux tree --json | python3 -c "
import json, sys
data = json.load(sys.stdin)
for w in data['windows']:
    for ws in w['workspaces']:
        if ws['ref'] == '$WS':
            print(ws['index'] + 1)")

# AppleScript でメニュークリック → PTY 初期化
osascript -e "
tell application \"System Events\"
    tell process \"cmux\"
        click menu item \"ワークスペース $WS_INDEX\" of menu 1 of menu bar item \"表示\" of menu bar 1
    end tell
end tell"
sleep 2

# 元のワークスペースに戻る
ORIG_INDEX=1  # 元のワークスペースの index+1
osascript -e "
tell application \"System Events\"
    tell process \"cmux\"
        click menu item \"ワークスペース $ORIG_INDEX\" of menu 1 of menu bar item \"表示\" of menu bar 1
    end tell
end tell"

注意: ソケット API のフォールバック

ソケット API surface.send_text / surface.read_text は、ターゲット surface の PTY が未初期化の場合、caller の surface にサイレントにフォールバックすることがある。レスポンスの surface_ref を確認して意図した surface に送信されたか必ず検証すること。

read-screen トラブルシューティング

read-screen の結果がおかしい場合は cmux refresh-surfaces → 再読み取りの順で試す。

ロングラン実行の監視

dev server やビルドなど長時間プロセスは専用ペインに分離し、read-screen で定期的に監視する。

cmux new-split right              # → surface:N
cmux send --surface surface:N "npm run dev\n"
# ポーリングで "ready" 等のキーワードを検出
screen=$(cmux read-screen --surface surface:N)

通知

# アプリ内通知（ペインハイライト、サイドバーバッジ。Cmd+Shift+U で移動）
cmux notify --title "完了" --body "ビルドが成功しました"

# macOS 通知センター（サウンド付き、別アプリ使用中でも表示）
osascript -e 'display notification "ビルド完了" with title "Claude" sound name "Glass"'

使い分け: cmux 内で注意を引く → cmux notify、ユーザーが別アプリにいる → osascript。

ステータス・プログレス表示

cmux set-status mykey "作業中" --icon hammer --color "#0099ff"  # サイドバーに表示
cmux clear-status mykey
cmux set-progress 0.5 --label "ビルド中..."                     # プログレスバー（0.0〜1.0）
cmux clear-progress

ブラウザ

cmux にはブラウザ自動化機能もある。詳細は cmux browser --help を参照。 cmux new-pane --type browser --url <url> でブラウザペインを作成できる。

環境変数

よくあるミス

コマンドクイックリファレンス