tmux_stream_read
Long-poll new events from a tmux stream, blocking until output or timeout. Returns events like output, window-add, and layout-change, filterable by pane or kind.
Instructions
Long-poll new events from a stream (blocks until output or timeout).
Returns {"events", "cursor", "alive", "lagged"}. Each event has a seq,
a type ("output", "window-add", "layout-change", "exit", ...) and,
where relevant, pane/window/session ids and data. For "output"
events data is the decoded pane text (ANSI stripped unless
strip_ansi=False).
Filter with pane (e.g. "%0") and/or kinds (e.g. ["output"]). The
cursor auto-advances between calls, so just call again to get the next
batch; pass an explicit cursor to re-read from a known point. lagged
is true if the buffer overflowed and some events were dropped.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| stream_id | Yes | ||
| timeout | No | ||
| max_events | No | ||
| pane | No | ||
| kinds | No | ||
| cursor | No | ||
| strip_ansi | No |