Skip to content

NeoServer for iOSとmacOSのOSC 7501プログラムステータス通知

iOSとmacOSのNeoServerで、ターミナルタスクの完了・失敗・承認要求の通知を受け取ります。OSC 7501通知の有効化とSSH経由でのテスト方法を解説します。

6 分で読めますNeoServer

別のサーバーを確認している間にリモートのビルドが完了する。別のターミナルでコーディングエージェントが承認待ちで止まる。NeoServerはiOSとmacOSでOSC 7501プログラムステータス通知に対応したので、タスクが完了・失敗・承認要求を必要としたときに、ターミナルを何度も見に行かなくても知らせてくれます。

通知をタップすれば、既存のターミナルセッションに戻れます。macOSでは、NeoServerがそのセッションの分割ペインを特定することもできます。

OSC 7501とは?

OSC 7501は、実行中のプログラムが自身の状態を報告するために使うターミナルエスケープシーケンスです。進行中の作業、完了したタスク、失敗、ユーザー入力を要する一時停止などを表現できます。プログラムは構造化されたステータス情報をターミナル出力経由で送り、ターミナル側がその表示方法を決めます。通信フォーマットはProgram Status Protocol仕様を参照してください。

**OSC 7501のレポートを出力するのは、実行中のプログラム側です。**通知をオンにしても、すべてのシェルコマンドがステータスを報告するようにはなりません。対応するコマンドラインツールが自らレポートを送れますし、自作スクリプトでもprintfで送信できます。

通知が発生する状態

NeoServerはiOSとmacOSの両方で次のルールを適用します:

レポートシステム通知
state=doneタスク完了
state=errorタスク失敗
state=blocked:kind=permission承認が必要
state=idleまたはstate=working通知なし
state=blocked:kind=questionまたはkind=auth通知なし

アプリがアクティブな間、NeoServerはユーザーがすでに見ているターミナルへの通知を抑制します。他のセッションからのレポートは通知できます。アプリがアクティブでない間も、NeoServerがターミナル出力を受け取り続けていれば通知が届きます。

メッセージや進行状況の繰り返し更新で通知が増えることはありません。NeoServerは急激な変化をまとめ、同じセッションからの通知を最低5秒は間隔を空け、そのセッションの前の通知を最新のもので置き換えます。

プログラムステータス通知を有効にする

  1. NeoServerの設定を開き、Terminal Settingsを見つけます。
  2. ターミナル設定ページの下部にあるProgram Status Notificationsを探します。iOSとmacOSではデフォルトで有効です。
  3. OSC 7501レポートを送るプログラムを実行します。NeoServerは、ターミナルを開いたり設定を切り替えたりしたときではなく、最初の空でないステータスレポートを受信した後にシステムの通知許可を要求します。
  4. システムの許可ダイアログで通知を許可します。以前に拒否している場合は、OSの通知設定でNeoServerの通知を有効にしてください。

最初のテストでは、許可ダイアログに答えるまでターミナルに留まってください。その後、下の遅延サンプルを実行し、NeoServerの別のターミナルへ切り替えます。

SSH経由で完了通知を試す

通常のSSHターミナルでサーバーに接続し、次を貼り付けます:

printf '\033]7501;state=working:id=demo:app=demo\033\\'
sleep 10
printf '\033]7501;state=done:id=demo:app=demo\033\\'

10秒の遅延の間に、NeoServerの別のターミナルセッションへ切り替えてください。NeoServerを開いたままにすれば、ステータス通知の流れを手軽にテストできます。最終レポートが処理された後、システムの通知設定に従って完了通知が届くはずです。

失敗や承認の通知を試すには、どちらかのサンプルを実行し、遅延の間に別のセッションへ切り替えます:

# Report a failed task.
sleep 10
printf '\033]7501;state=error:id=demo:app=demo\033\\'
# Report a task waiting for approval.
sleep 10
printf '\033]7501;state=blocked:id=demo:kind=permission:app=demo\033\\'
sleep 10

承認サンプルの最後の遅延は、シェルがプロンプトに戻る前にブロックレポートを保持しておくためのものです。通知が届く時間を残しておき、それから元のターミナルに戻ってください。レポートをすぐにクリアしたり置き換えたりすると、保留中の通知がキャンセルされることがあります。

これらのコマンドはステータスを報告するだけです。承認のサンプルは操作を実行したり権限を与えたりしません。通知をタップするとターミナルが開き、そこで実際のプログラムの要求を確認できます。

自作スクリプトにステータスレポートを組み込む

コマンドをラップして、終了結果を明示的な完了または失敗レポートに変換します:

#!/bin/sh

printf '\033]7501;state=working:id=job:app=script\033\\'

# Replace this command with your build or other task.
if sh -c 'sleep 10'; then
    result=0
    state=done
else
    result=$?
    state=error
fi

printf '\033]7501;state=%s:id=job:app=script\033\\' "$state"
exit "$result"

接続中のターミナルでこのスクリプトを実行すると、NeoServerがその出力を受け取ります。この例ではコマンドの終了コードを保存します。通知テキストをカスタマイズする場合、プロトコルのtitleとmsgフィールドにはBase64エンコードされた単一行のUTF-8テキストを渡します。appは短いプログラム識別子です。

iOSのバックグラウンド挙動と通知が届かない場合

これらは受信したターミナル出力から生成されるローカルのシステム通知です。NeoServerがその出力を受け取って解析し続けられる必要があります。iOSがアプリをサスペンドまたは終了させると、リモートのステータス変化から新しい通知を生成できません。リモートのジョブは動き続けても、新しい警告がiPhoneに届かないことがあります。

通知が届かないときは、次の点を確認してください:

  • **まず直接のSSHで試す。**サンプルがそこでは動くのにtmuxやscreenの中では失敗するなら、その層がOSCシーケンスをNeoServerへ転送しているか確認してください。
  • **元のターミナルから離れる。**アクティブで表示中のターミナルは、意図的に静かに保たれます。
  • **権限とApp内トグルの両方を確認。**システムの通知設定や集中モードの設定が、バナー表示に影響することがあります。
  • **レポートを十分な時間保持する。**レポートをすぐにクリアしたり状態を変えたりすると、保留中の通知がキャンセルまたは置き換えられることがあります。
  • **報告された状態を確認。**質問や認証の一時停止は承認通知を引き起こしません。承認にはkind=permissionを持つblockedが必要です。

通知をタップすると既存のセッションが選択されます。そのセッションがすでに閉じている場合はNeoServerがその旨を伝えます。再接続やコマンドの自動実行は行いません。Appがロックされている場合、ロックが解除されるまでナビゲーションは待機します。

接続の設定方法はNeoServerクイックスタートを、ターミナル設定の残りの項目はTerminal Settingsを参照してください。

NeoServer

SSH, Mosh, Docker & SFTP client for iPhone, iPad and Mac

App Store

試してみませんか?

NeoServer · SSH, Mosh, Docker & SFTP client for iPhone, iPad and Mac

App Store で無料