diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-06-29 21:36:48 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-06-29 21:36:48 +0300 |
| commit | 9150ed6268874d1f2a314b1ddbf531b66df1e105 (patch) | |
| tree | b8e8c35fb703b5b59babbdb8e4d732f906face41 /docs | |
| parent | f36d8043594489508046ff0852989ec08f52188a (diff) | |
feat: add session snapshot api
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/next/CHANGELOG.md | 3 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/socket-api.mdx | 10 |
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/next/CHANGELOG.md b/docs/next/CHANGELOG.md index 553f4044..b05a2618 100644 --- a/docs/next/CHANGELOG.md +++ b/docs/next/CHANGELOG.md @@ -2,6 +2,9 @@ ## Unreleased +### Added +- Added `session.snapshot` to bootstrap client runtime state in one socket API response before subscribing to events. + ### Changed - Bumped the client/server protocol version to 15 for socket API placement mutation event and response compatibility. diff --git a/docs/next/website/src/content/docs/socket-api.mdx b/docs/next/website/src/content/docs/socket-api.mdx index d651cc20..08cd2107 100644 --- a/docs/next/website/src/content/docs/socket-api.mdx +++ b/docs/next/website/src/content/docs/socket-api.mdx @@ -83,6 +83,7 @@ Raw socket method names use dot notation: | Server | `ping`, `server.stop`, `server.reload_config`, `server.agent_manifests`, `server.reload_agent_manifests` | | Notification | `notification.show` | | Client | `client.window_title.set`, `client.window_title.clear` | +| Session | `session.snapshot` | | Workspace | `workspace.create`, `workspace.list`, `workspace.get`, `workspace.focus`, `workspace.rename`, `workspace.move`, `workspace.close` | | Worktree | `worktree.list`, `worktree.create`, `worktree.open`, `worktree.remove` | | Tab | `tab.create`, `tab.list`, `tab.get`, `tab.focus`, `tab.rename`, `tab.move`, `tab.close` | @@ -95,6 +96,15 @@ Raw socket method names use dot notation: Some CLI commands are conveniences around these methods. For example, `herdr agent wait` resolves an agent target and then subscribes to pane agent state events. +`session.snapshot` returns a one-time bootstrap snapshot for clients that keep +their own local runtime cache. The response includes version/protocol metadata, +focused workspace/tab/pane ids, workspace records, tab records, pane records, +tab layout snapshots, and agent records. It is not a subscription; after reading +it, subscribe to resource events and update the local cache from those events. +Call `session.snapshot` again after reconnecting or when the local cache may be +stale. Attached worktree provenance is included on workspace records. Full repo +worktree discovery remains `worktree.list`. + Pane control methods use public pane ids such as `w1:p1`. Methods whose schema makes `pane_id` optional use the server's active focused pane when it is omitted. `pane.move` always requires the source `pane_id`. |