Core LibraryAPI Reference

Choose documentation 3

Concept and alpha: example support scope and release maturity.

v0.1.0.alpha.2

Current version

v0.1.0.alpha.2
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

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
Server class 39 members

Connects to an existing endpoint. Closing retires clients, never the daemon.

Session 2 types
Session class 21 members
SessionWhere module 1 member
Window 4 types
Window class 18 members
WindowLink class 19 members
WindowWhere module 1 member
Pane 2 types
Pane class 27 members
PaneWhere module 1 member
Client 1 type
ClientWhere module 1 member
Hooks 1 type
Hooks class 5 members

Hook values are executable tmux command strings, never literal data.

Options 1 type
OptionValue class 7 members

Raw bytes remain available even when a caller requests a typed conversion.

Commands 3 types
Cancellation class 5 members

IDs printed by the creation command itself, before later topology changes. A receipt proves creation, not continued ownership or current membership.

Endpoint class 8 members

Explicit executable and socket selection. Construction starts no clients.

Control mode 4 types
GuardedBlock class 8 members
GuardedReply class 7 members

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
FilterExpr class 13 members

A schema-validated predicate over captured records; evaluation performs no I/O.

Snapshots 8 types
CapturedRecord class 7 members
ClientSnapshot class 21 members
PaneSnapshot class 22 members
Selection class 14 members

Replayable captured membership. Snapshot construction owns record values.

SessionSnapshot class 16 members
Snapshot class 14 members

A validated graph observed over an interval, with no transport reference.

WindowSnapshot class 16 members
Errors 18 types
Constants and enums 5 types
CommandResult class 11 members
ControlEvent class 13 members
GroupResult class 5 members

Final client status cannot attribute a merged group result to individual steps.

Options class 4 members

Explicit acquisition and mutation at one option scope.

TerminalResult class 6 members

Terminal bytes go directly to the caller's TTY and are not captured.

Async 1 type
Async module 6 members
Other 3 types
Entity class 12 members
EntityRef class 9 members

A target belongs to one open server binding; names never identify it.

Support module 3 members

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.

Esc

Type to search.

Reference preview Open reference