API reference
Browse the Swift types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 4 types
A tmux server, addressed by its endpoint.
A tmux server found listening on a socket.
The bounded result of scanning for tmux servers.
The identity of one running tmux daemon at one endpoint.
Session 2 types
Window 6 types
One tmux window, independent of every session that links it.
Where a new window goes relative to one that is already there.
A tmux window id such as @1.
The session-local identity of one link to a window.
One session-local link to a window.
One window and one session-local appearance, read from the same tmux reply.
Pane 4 types
A tmux pane, as it was when the listing was read.
Where a split puts the pane it creates.
How big a split makes the pane it creates.
A tmux pane id such as %1.
Client 1 type
A client attached to a tmux server.
Hooks 2 types
Options 2 types
The exact tmux table that owns an option.
One tmux option.
Buffers 1 type
One of the server's paste buffers.
Layout and geometry 1 type
Which way a resize moves the boundary a pane shares with its neighbour.
Environment 2 types
Which environment a variable lives in.
One variable in a tmux environment.
Versions 1 type
A tmux release, ordered the way tmux numbers them.
Commands 2 types
Several tmux commands sent in one invocation.
One tmux command, as argv.
Control mode 4 types, 1 function or constant
One command's reply, framed between tmux's %begin and its terminator.
Something tmux said without being asked.
A live control-mode connection.
One observer's control notifications with finite pending storage.
A lazy view of subscription changes from one bounded notification observer.
Formats 1 type
A format tmux reports changes to, rather than being asked for.
Queries 6 types, 3 functions and constants
A value a filter can compare against.
A model that can be filtered declaratively.
How a filter compares one field.
Builds a filter from a field__operator=value lookup written as text.
The filtering vocabulary, as a document.
A quantified filter over a relation, as one value.
The one element the filter matches.
Every element the filter matches, in order.
The one element the filter matches, or nil if none did.
Queries — Operators 2 types
A typed operator. The Value it is built for is the projected type of the key path it is paired with, so pairing a text operator with an integer field is a compile error rather than a runtime surprise.
How many related objects have to match.
Queries — Expressions 1 type
A filter over one model, held as data.
Snapshots 4 types
Where a previous read of a pane stopped.
What a pane has said since a cursor was taken.
A bounded read of a pane.
Every object read from one daemon incarnation.
Errors 11 types, 1 function or constant
Why a filter could not be built.
Why a decoded filter cannot be evaluated safely.
Why selecting one result from a filter failed.
Why a filter keyword could not be turned into a comparison.
Why a filtered listing failed.
Why a RegexPattern could not be compiled.
Why a compiled RegexPattern could not finish matching.
Everything a tmux operation can fail with.
A tmux reply that did not match its projection.
Why a lookup that expected exactly one match did not get one.
Why waiting for pane output failed before it produced an outcome.
Narrowing a scope's thrown type back to TmuxError.
Constants and enums 1 type
How work reaches tmux.
Testing utilities 3 types, 15 functions and constants
Reads a descriptor until it is told to stop, and proves it has stopped before the descriptor can be closed.
Thrown when a name-addressed case runs without a directory to put it in.
The reaper was asked to remove a path outside this port's owned roots.
Library-managed control mode needs a daemon of 3.7 or newer.
Exact named-buffer deletion and rename need 3.4.
The directory a socket name resolves inside, when the run provides one.
Whether this run can address servers by socket name inside the suite's root.
Whether the lane's tmux is at least major.minor plus a patch letter.
Whether the lane is exactly the release major.minor, with no patch letter.
A reaper that outlives this process, so a killed run leaves no server behind.
Runs executable and captures what it prints, without this library.
The lane binary when a matrix runner selected one, otherwise the first tmux on PATH, otherwise the first usual install location that exists. A bare name in the variable is searched for on PATH. Resolved to a path because the transport never searches PATH.
The release of the lane's tmux executable, read without a fork.
Waits until a pane's shell has drawn its first prompt.
Waits for a stopped daemon's Unix listener to close before reusing its path.
Polls condition until it holds, and reports whether it did.
Runs body against a private tmux server addressed by socket name, and always kills it.
Runs body against a private tmux server and always kills it — including when this process is killed outright.
Other 8 types
Finding the tmux servers already running on this machine.
Where a tmux server listens.
A regular-expression feature this package deliberately does not execute.
A compiled regular expression with bounded memory and matching work.
What tmux said.
Where the tmux this process is running inside can be found.
What a wait on a pane's output ended on.
One report that a subscribed format's value changed.