API reference
Browse the Raku types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 4 types
Immutable connection settings. Construction performs no tmux operation.
Value-only daemon identity. Retaining it keeps no process or executor alive.
One immutable pairing of daemon identity and capability evidence.
Session 5 types, 1 function or constant
Captured session with local window-link and group relationships.
Captured session group whose members are resolved within this graph.
Replayable typed sessiongroup membership with local filtering.
Value-only command target for a session in one daemon incarnation.
Replayable typed session membership with local filtering.
A session identifier's spelling; existence and daemon ownership are separate.
Window 6 types, 1 function or constant
Captured physical window; session-relative indices belong to WindowLink.
One captured session/index association with an expected physical window.
A session/index target with an expected window. Renumbering checks are not atomic.
Replayable typed window-link membership with local filtering.
Value-only command target for a physical window, independent of its links.
Replayable typed window membership with local filtering.
A physical window identifier. An index in a session is a different value.
Pane 3 types, 1 function or constant
Captured pane fields and its local physical-window relationship.
Value-only command target for a physical pane in one daemon incarnation.
Replayable typed pane membership with local filtering.
A pane identifier scoped to a captured daemon incarnation.
Client 7 types
Captured attached-client fields; commands use its separate reference.
A value-only client target. No subprocess or connection is retained.
A menu entry. Empty labels are separators; labels retain tmux display styles.
A captured client identity with explicit inspection and inherited client commands.
Replayable typed client membership with local filtering.
Hooks 1 type
Named hook command arrays. Reading a hook never executes its command source.
Options 2 types
One source-qualified option type, scope and operand range.
One observed option value. The source schema determines its native scalar type.
Keys and bindings 2 types
Captured binding metadata. Legacy listings leave note-state Unloaded.
Server key tables. Invocation keeps stored command arguments distinct.
Buffers 4 types
Buffer metadata is separate from explicitly acquired binary contents.
Server-scoped paste buffers with binary load and save operations.
Captured buffer metadata; it does not retain or implicitly load buffer content.
Replayable typed buffer membership with local filtering.
Layout and geometry 2 types, 1 function or constant
Decoded layout plus exact source bytes, including unsupported future versions.
Decode a declared dialect. Unknown versions retain bytes without a guessed tree.
Environment 2 types
Session or global environment, including hidden and removed entries.
Environment absence and an explicit removed marker are different states.
Terminal capabilities 1 type
Versions 5 types, 3 functions and constants
Packaged, source-qualified fields, relationships, options and release profiles.
Typed schema lookup used by acquisition, local criteria and documentation.
Ordered release profiles are the sole source of the floor and CI endpoints.
Parsed release spelling; an exact release can still lack a support profile.
Capability evidence never treats an unprobed feature as supported.
Return the validated packaged catalogue; no tmux command is executed.
Preserve the raw string and reject vendor/development suffixes as unqualified.
Return the immutable release policy without reading configuration or contacting tmux.
Commands 11 types
A finite replayable sequence of explicit commands, without transaction semantics.
Caller-supplied evidence for one named operation, not a command acknowledgement.
One immutable command and an explicit completion contract.
Captured per-operation results. No runtime, control owner or caller task is retained.
Explicit tmux command-template syntax, including percent substitutions.
One copied tmux command with distinct argv and command-language encodings.
One-shot cancellation shared by explicitly selected operations.
What the caller knows about an operation's effects.
Control mode 6 types
Incremental LF framing with exact response guards and bounded retained data.
Pane output is terminal bytes, not an independently decodable UTF-8 string.
A matched command guard pair acknowledges execution, not asynchronous effects.
Some queued jobs print after their end guard; preserve that unframed line.
Formats 4 types
Exact captured field bytes and scalar values. Text conversion is explicit.
Incremental LF framing over bytes with terminal failure and explicit limits.
Ordered registered fields with an explicit acquisition context and codec.
Queries 7 types
A schema-validated local matcher with copied, immutable criteria and AST.
Immutable resource limits applied before recursive validation or JSON parsing.
Pure, inspectable source restrictions plus the original local filter.
Eager captured membership; transformations perform no acquisition or commands.
Queries — Expressions 1 type
An immutable observed layout cell; floating leaves need not tile their parent.
Snapshots 3 types
Captured records and indexed relations; it retains no transport or live owner.
A local view of one captured record. Accessors and relations never perform I/O.
Availability states preserve absence without conflating false, zero or empty text.
Errors 10 types
Typed acquisition, decoding, query, ownership and command failures.
Base for explicit library failures; operational failures are never absence.
Exact or optional cardinality was violated.
A child command failed; outcome states whether an effect may have occurred.
Captured bytes violate the declared projection or field codec.
Contextual rows disagree about one physical entity in a capture interval.
Criteria are invalid before any collection traversal occurs.
A requested local field or relation was not acquired in this observation.
A target belongs to a daemon incarnation which is no longer current.
A capability is unavailable or not established for the connected daemon.
Constants and enums 5 types
One position's outcome, preserving its acknowledgement and original exception.
Typed native options. Reads and writes are explicit daemon operations.
One notification, retaining its original bytes without the record terminator.
An unrecognized notification remains inspectable without interpreting its body.
Captured child output. Complete means process completion, not application effects.