aboutsummaryrefslogtreecommitdiff
path: root/website/src/content/docs/ja/socket-api.mdx
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-07-21 21:01:27 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-07-21 21:01:27 +0300
commitbc064e9d034711ba40e4e42a0129934752f0b802 (patch)
treea3e767a6fb8f4545d329768f68c083b720afbc2b /website/src/content/docs/ja/socket-api.mdx
parent7c189003464fce851736096b309078aaff7640c7 (diff)
docs: finalize release docs and refresh agent skill
Diffstat (limited to 'website/src/content/docs/ja/socket-api.mdx')
-rw-r--r--website/src/content/docs/ja/socket-api.mdx86
1 files changed, 80 insertions, 6 deletions
diff --git a/website/src/content/docs/ja/socket-api.mdx b/website/src/content/docs/ja/socket-api.mdx
index 975336ca..8995dbae 100644
--- a/website/src/content/docs/ja/socket-api.mdx
+++ b/website/src/content/docs/ja/socket-api.mdx
@@ -36,7 +36,7 @@ herdr api schema --output herdr-api.schema.json
- ワークスペースの作成、一覧、フォーカス、名前変更、クローズ
- タブの作成、一覧、フォーカス、名前変更、クローズ
- ペインの一覧、調査、分割、入れ替え、フォーカス、リサイズ、名前変更、読み取り、クローズ、入力送信
-- CLI ヘルパーを通じたエージェントの一覧、調査、読み取り、送信、名前変更、フォーカス、起動、アタッチ
+- CLI ヘルパーを通じたエージェントの一覧、調査、読み取り、プロンプト、待機、名前変更、フォーカス、起動、アタッチ
- フックやプラグインからのカスタムエージェント状態の報告
- イベントの購読と、出力や状態変化の待機
- 組み込みインテグレーションのインストールとアンインストール
@@ -77,7 +77,7 @@ herdr pane split w1:p1 --direction right --ratio 0.333
エージェントを待つ:
```bash
-herdr wait agent-status w1:p1 --status done
+herdr agent wait w1:p1 --until done
```
ペインの出力を読む:
@@ -102,12 +102,12 @@ herdr pane read w1:p2 --source recent --lines 50
| ペイン | `pane.split`、`pane.swap`、`pane.move`、`pane.zoom`、`pane.layout`、`pane.process_info`、`pane.neighbor`、`pane.edges`、`pane.focus_direction`、`pane.resize`、`pane.list`、`pane.current`、`pane.get`、`pane.rename`、`pane.send_text`、`pane.send_keys`、`pane.send_input`、`pane.read`、`pane.graphics.info`、`pane.graphics.set`、`pane.graphics.clear`、`pane.graphics.stream`、`pane.report_agent`、`pane.report_agent_session`、`pane.report_metadata`、`pane.clear_agent_authority`、`pane.release_agent`、`pane.close`、`pane.wait_for_output` |
| ポップアップ | `popup.close` |
| レイアウト | `layout.export`、`layout.apply`、`layout.set_split_ratio` |
-| エージェント | `agent.list`、`agent.get`、`agent.read`、`agent.explain`、`agent.send`、`agent.rename`、`agent.focus`、`agent.start` |
+| エージェント | `agent.list`、`agent.get`、`agent.read`、`agent.explain`、`agent.send_keys`、`agent.prompt`、`agent.wait`、`agent.rename`、`agent.focus`、`agent.start` |
| イベント | `events.subscribe`、`events.wait` |
| インテグレーション | `integration.install`、`integration.uninstall` |
| プラグイン | `plugin.link`、`plugin.list`、`plugin.unlink`、`plugin.enable`、`plugin.disable`、`plugin.action.list`、`plugin.action.invoke`、`plugin.log.list`、`plugin.pane.open`、`plugin.pane.focus`、`plugin.pane.close` |
-一部の CLI コマンドは、これらのメソッドの便利ラッパーです。たとえば `herdr agent wait` は、エージェントターゲットを解決してからペインのエージェント状態イベントを購読します。
+`agent.wait` はサーバー所有でイベント駆動です。解決したペイン占有者に固定されるため、置換されたエージェントが待機を満たすことはありません。`agent.prompt` は `until` と `timeout_ms` を持つ省略可能な `wait` オブジェクトを受け付けます。これにより、プロンプト送信と待機開始を 1 つのリクエストで行い、別々の呼び出し間の競合を避けられます。
`session.snapshot` は、独自のローカルランタイムキャッシュを持つクライアント向けに、一度限りのブートストラップスナップショットを返します。レスポンスには、バージョン/プロトコルメタデータ、フォーカス中のワークスペース/タブ/ペイン id、ワークスペース、タブ、ペイン、タブレイアウト、エージェントの各レコードが含まれます。これは購読ではありません。取得後はリソースイベントを購読し、そのイベントでローカルキャッシュを更新してください。再接続後やキャッシュが古い可能性がある場合は、`session.snapshot` を再度呼び出します。ワークスペースレコードには、関連付けられた worktree の出自情報も含まれます。リポジトリ全体の worktree 検出には引き続き `worktree.list` を使います。
@@ -297,6 +297,80 @@ Worktree メソッドは Git チェックアウトを Herdr ワークスペーã‚
worktree コマンドはライフサイクルイベントも発行します。`worktree.create` は `workspace.created`、`tab.created`、`pane.created`、`worktree.created` を発行します。`worktree.open` は `worktree.opened` を発行し、新しい Herdr ワークスペースを開いた場合はワークスペース/タブ/ペインの作成イベントも発行します。`worktree.remove` は `worktree.removed` を発行し、リンクされたワークスペースがまだ開いている場合は `workspace.closed` も発行します。
+## エージェントビューのクエリ
+
+`agent.view.set` は、組み込みの Agents ビューに一つの一時的な宣言型プロジェクションを
+設定します。エージェントの情報や現在の UI コンテキストが変わるたびに再評価されます。
+展開・折りたたみサイドバー、モバイルの Agents リスト、マウスターゲット、番号付き
+フォーカス、前後のエージェントへの移動順を制御します。`agent.list`、通知、検出、
+グローバルな要対応件数は変更しません。
+
+現在表示中の Space にいるエージェント、または別の場所で対応が必要なエージェントを
+表示し、要対応度と直近の状態遷移で並べ替える例です:
+
+```json
+{
+ "id": "view_set",
+ "method": "agent.view.set",
+ "params": {
+ "source": "plugin:example.agent-views",
+ "label": "focus",
+ "filter": {
+ "op": "any",
+ "filters": [
+ {
+ "op": "eq",
+ "field": "workspace_id",
+ "value": {"context": "current_workspace_id"}
+ },
+ {
+ "op": "in",
+ "field": "status",
+ "values": ["blocked", "done"]
+ }
+ ]
+ },
+ "sort": [
+ {"field": "attention", "order": "desc"},
+ {"field": "state_change_seq", "order": "desc"}
+ ]
+ }
+}
+```
+
+フィルターノードの `op` には `all`、`any`、`not`、`eq`、`in`、`exists` を使います。
+組み込みフィールドは `status`、`workspace_id`、`tab_id`、`pane_id`、`agent`、
+`seen`、`state_change_seq` です。プラグインが報告したペインメタデータを絞り込むには、
+フィールドとして `{"token":"name"}` を使います。値には文字列、真偽値、符号なし整数、
+またはコンテキストオブジェクトを指定できます。コンテキスト値は
+`current_workspace_id` と `current_tab_id` で、対応する ID フィールドとの比較にだけ
+使えます。有効な status は `idle`、`working`、`blocked`、`done`、`unknown` です。
+`done` は idle かつ未確認の状態を表します。
+
+ソートフィールドは `workspace_order`、`tab_order`、`pane_order`、`attention`、
+`status`、`agent`、`seen`、`state_change_seq`、または `{"token":"name"}` です。
+ソートは安定しており、指定順に評価され、`asc` または `desc` を受け付けます。値がない
+項目は値がある項目の後に残ります。`sort` を省略すると既存の
+`ui.agent_panel_sort` ポリシーが有効です。カスタムソートは設定を書き換えず、一時的に
+そのポリシーを置き換えます。
+
+`source` は所有者を識別します。プラグインは `plugin:<HERDR_PLUGIN_ID>` を使います。
+所有元のプラグインが存在しないか無効な場合、Herdr は設定を拒否します。他の呼び出し元は
+独自の非 `plugin:` source を使えます。設定に成功すると以前のビューはアトミックに
+置き換えられます。ビューは clear または置換されるか、所有プラグインが disable、unlink、
+uninstall されるか、サーバーが終了するまで有効です。永続的な動作が必要なプラグインは、
+クエリを `HERDR_PLUGIN_STATE_DIR` に保存し、`[[startup]]` フックから再適用してください。
+
+無条件で clear するか、指定した source がまだ所有している場合だけ clear できます:
+
+```json
+{"id":"view_clear","method":"agent.view.clear","params":{}}
+{"id":"view_clear_owned","method":"agent.view.clear","params":{"source":"plugin:example.agent-views"}}
+```
+
+source が一致しない場合、アクティブなビューは変わりません。set と clear のレスポンスは
+`type: "agent_view"` で、`active`、`source`、任意の `label` を報告します。
+
## プラグイン API
プラグイン API は、実行可能なワークフローツールのための初期のホスト面です。プラグインは `herdr-plugin.toml` マニフェストを持つパッケージです。マニフェストは、共有可能なアクション、イベントフック、ターミナルペインのエントリーポイント、リンクハンドラーを宣言します。アクションとペインはマニフェスト専用です。ランタイムでのアクション登録とランタイムでの argv ペイン作成は v1 の範囲外です。
@@ -589,8 +663,8 @@ herdr pane read w1:p1 --source detection
エージェントとスクリプトの協調には wait を使います。
```bash
-herdr wait agent-status w1:p1 --status done
-herdr wait agent-status w1:p1 --status blocked
+herdr agent wait w1:p1 --until done
+herdr agent wait w1:p1 --until blocked
```
エージェントの wait は、任意のコマンドの完了ではなく意味的な状態を観測します。