API reference
Browse the Ruby types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 1 type
Connects to an existing endpoint. Closing retires clients, never the daemon.
Session 2 types
Window 4 types
Client 1 type
Hooks 1 type
Hook values are executable tmux command strings, never literal data.
Options 1 type
Raw bytes remain available even when a caller requests a typed conversion.
Commands 3 types
IDs printed by the creation command itself, before later topology changes. A receipt proves creation, not continued ownership or current membership.
Explicit executable and socket selection. Construction starts no clients.
Control mode 4 types
Blocks observed between private boundaries may include hooks. They do not establish command ownership, final status, or completion of delayed effects.
Queries — Expressions 1 type
A schema-validated predicate over captured records; evaluation performs no I/O.
Snapshots 8 types
Replayable captured membership. Snapshot construction owns record values.
A validated graph observed over an interval, with no transport reference.
Errors 18 types
Constants and enums 5 types
Final client status cannot attribute a merged group result to individual steps.
Explicit acquisition and mutation at one option scope.
Terminal bytes go directly to the caller's TTY and are not captured.
Async 1 type
Other 3 types
A target belongs to one open server binding; names never identify it.
Here "support" means which tmux releases libtmux supports, not helper code. Every server handle checks its daemon's release before any command runs; this module exposes that check.