diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-28 05:06:04 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-28 05:06:27 +0300 |
| commit | 2d8b4e2db4642dede084801c03516046f205626b (patch) | |
| tree | 909338388764efbaa8bc487f90e5e9f6d8a323a6 /docs/next/website/src | |
| parent | 986e4a17767a3d4838e340b92cb2db9e6012acc4 (diff) | |
feat: expose agent session refs in api
Diffstat (limited to 'docs/next/website/src')
| -rw-r--r-- | docs/next/website/src/content/docs/cli-reference.mdx | 6 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/socket-api.mdx | 15 |
2 files changed, 20 insertions, 1 deletions
diff --git a/docs/next/website/src/content/docs/cli-reference.mdx b/docs/next/website/src/content/docs/cli-reference.mdx index ed51ce1e..d79e34d0 100644 --- a/docs/next/website/src/content/docs/cli-reference.mdx +++ b/docs/next/website/src/content/docs/cli-reference.mdx @@ -129,9 +129,13 @@ herdr pane report-agent <pane_id> \ --state idle|working|blocked|unknown \ [--message TEXT] \ [--custom-status TEXT] \ - [--seq N] + [--seq N] \ + [--agent-session-id ID] \ + [--agent-session-path PATH] ``` +`pane get`, `pane list`, `agent get`, and `agent list` include a read-only `agent_session` object when an official integration has reported a native session reference. If no native session reference is stored, the field is omitted. + Report display-only pane metadata without taking over semantic state: ```bash diff --git a/docs/next/website/src/content/docs/socket-api.mdx b/docs/next/website/src/content/docs/socket-api.mdx index 3b12d928..382a3c62 100644 --- a/docs/next/website/src/content/docs/socket-api.mdx +++ b/docs/next/website/src/content/docs/socket-api.mdx @@ -163,6 +163,21 @@ Integrations report agent state with `pane.report_agent`. `custom_status` is visual. It can show a short label like `indexing` without changing semantic behavior. +Official integrations can also report a native session reference. `pane.get`, `pane.list`, `agent.get`, and `agent.list` expose a read-only `agent_session` object when Herdr has a stored native session reference: + +```json +{ + "agent_session": { + "source": "herdr:codex", + "agent": "codex", + "kind": "id", + "value": "..." + } +} +``` + +If no native session reference is stored, the field is omitted. + Use `pane.report_metadata` when a user hook wants to customize presentation without taking over lifecycle state from a Herdr integration. ```json |