API reference
Browse the Perl types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 1 type
Explicit tmux acquisition and commands
Session 1 type
Captured session entity
Window 2 types
Captured window entity
Captured window_link entity
Pane 1 type
Captured pane entity
Client 1 type
Captured client entity
Commands 3 types
Executor-independent prepared command continuations
Shared owned process-supervision boundary
Supervised literal process execution
Queries 10 types
Native array selection of captured client entities
Validated, reusable local criteria and explicit wire data
Native array selection of captured pane entities
Explainable explicit pane acquisition
Catalog and explicit record adapters
Native array selections with fixed query returns
Local cursor over frozen membership
Native array selection of captured session entities
Native array selection of captured window_link entities
Native array selection of captured window entities
Snapshots 1 type
Captured graph with explicit completeness
Errors 24 types
Shutdown has started and new work is refused. Callers may still observe cleanup through "close" in LibTmux::Async::Transport.
Shutdown has started and new work is refused. Callers may still observe cleanup through "close" in LibTmux::Async::Transport.
The configured running and pending limits are occupied. No command was submitted for this request. Returned through a failed Future.
Typed failures with readable diagnostics
Observed generations or topology changed during capture.
Execution was cancelled; cancellation does not roll back effects.
A tmux record or field could not be decoded.
tmux reported nonzero status; result retains stdout/stderr/status.
A creation command succeeded but subsequent receipt decoding or capture failed. created returns a minimal generation-scoped entity handle when the command's receipt was decoded; other fields remain unloaded. cause preserves the original acquisition failure. dispatched is true. The returned handle permits explicit, generation-checked cleanup; absent receipts leave effects uncertain. See "new_session" in LibTmux::Server.
Invalid operation or transport argument before dispatch.
Invalid criteria data; path, expected, and received describe the boundary.
Undefined, hole, wrong-kind, or incompatible-generation membership.
At least two occurrences matched. matched_ids preserves occurrence diagnostics.
No occurrence matched one().
The selected stable target no longer exists. Native result diagnostics are retained. This differs from a stale generation and from an arbitrary command failure; acquire a new snapshot before choosing recovery.
Retained process output exceeded the configured bound.
Native candidates disagree with captured local matches, or an expert native query returned an uncaptured ID. details->{verification} contains the detached "VERIFICATION REPORT" in LibTmux::Server. The cause may be concurrent change, a translation defect or backend semantics; the comparison does not identify it. "query_panes" in LibTmux::Server throws this for require or expert queries, while auto reports fallback through its optional observer.
The executable could not start; dispatch is distinguished from command failure.
A captured generation or contextual target no longer identifies the same resource.
Execution exceeded its deadline; effects may already have occurred.
Process supervision or result framing failed.
A required field or relation is not available in captured data.
A daemon or execution capability is unavailable.
A local value has no supported portable wire representation.
Errors — Server 1 type
The selected server cannot be reached.
Constants and enums 1 type
Completed or partial subprocess outcome