API reference
Browse the Elixir types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 1 type
Describes a local tmux server for capturing state and running commands.
Session 1 type
An immutable session observation with explicit actions. Attachment retains tmux's client count.
Window 2 types
An immutable physical window with explicit actions, independent of session membership and index.
An observed session/index/window binding. Its key is not a link lifetime ID.
Pane 1 type
An immutable physical pane with explicit actions. It belongs to a window; text may be empty.
Client 1 type
An immutable attached-client observation, keyed by validated client name.
Commands 4 types
A command value with separate argv and tmux-text renderers.
A node-local monotonic deadline shared by every stage of an operation.
A retained operation handle pinned to its original owner, tables and epoch.
Executes one explicitly selected executable with bounded captured output.
Control mode 2 types
Formats 2 types
Queries 4 types
A validated portable predicate over one observed entity type.
Defines observed fields, wire names and graph relations.
An ordered, materialized Enumerable over one captured entity type.
Bounded JSON decoding with duplicate keys preserved until validation.
Snapshots 3 types
Requests 1 type
Data for the qualified control lane's supported commands.
Errors 4 types
An action result did not meet an explicit completion requirement.
A managed execution reported an error after admission.
A scoped callback finished, but connection cleanup was not proved.
An inspectable failure with its phase and certainty about effects.
Constants and enums 1 type
Shared results for explicit pane, window and session actions.
By module 4 modules
-
LibTmux.Action 1
-
LibTmux.Control 3
-
LibTmux.Transport 1