API reference
Browse the Erlang types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 1 type
Open tmux endpoints and execute explicit command values.
Session 1 type
Create and observe sessions, or act on a session's registered stable ID.
Window 2 types
Create physical windows in a session and act through their registered IDs.
Act on a physical window's observed membership in a particular session.
Pane 1 type
Create, observe and rearrange panes using registered physical IDs.
Hooks 1 type
Store builtin hook commands and run them in an explicit observed context.
Options 1 type
Read and change explicit tmux option tables through registered references.
Keys and bindings 1 type
Register and remove bindings in explicit server key tables.
Buffers 1 type
Load, inspect and paste tmux byte buffers through an explicit endpoint.
Terminal capabilities 1 type
Look up source-derived native command declarations and feature minimums.
Versions 1 type
Parse the output of tmux -V without invoking tmux.
Commands 3 types
Build tmux commands and bounded sequences without performing I/O.
Own a command independently of an individual wait.
Run synchronous work and cleanup while preserving both outcomes.
Control mode 1 type
Own an explicit persistent tmux control attachment.
Queries 6 types
Construct portable conditions and prepare them against captured values.
Decode bounded JSON using OTP's json parser and binary object keys.
Prepare a trusted local predicate once for a captured snapshot.
Build and execute explicit queries over the tmux graph.
Validate schema-defined observations and normalize scalar values.
Filter ordered captured rows without tmux I/O.
Snapshots 3 types
Observe a Linux process incarnation using its PID, boot ID and start ticks.
Validated native domain records. Constructors perform no tmux I/O.
Read an immutable captured graph without performing tmux I/O.
Errors 1 type
Explain library exceptions through Erlang's native error formatter.