API reference
Browse the Kotlin types and operations for working with tmux. Start with the core objects below, or search for a type or member.
Server 2 types, 1 function or constant
Manages sessions, windows, and panes on a tmux server.
Marks every builder below so an inner block cannot reach an outer block's receiver by accident: split { directory = x } inside window { } resolves to the innermost SplitBuilder , never to the WindowBuilder it is nested in. Reaching the outer receiver on purpose still works, spelled explicitly (this@window.directory = x).
Opens a Server , runs block , and closes it — even if block throws or is cancelled.
Session 2 types
A tmux session and its captured windows and properties.
Configure a new session, its initial command, and its windows with Server.newSession .
Window 2 types
A tmux window at a specific position in a session.
Configure a window and its pane splits inside a SessionBuilder block.
Pane 1 type
A tmux pane, with operations for input, output, and layout.
Client 1 type
An attached tmux client and its captured properties.
Hooks 1 type
Read and update hooks for the server, session, window, or pane that owns this handle.
Options — Functions 2 functions and constants
java.util.OptionalInt
The value, or null when absent: an exit status, a captured server pid.
Keys and bindings 1 type
The server's key bindings, in one key table or across all of them.
Buffers 1 type
The tmux server's paste buffers.
Layout and geometry 1 type
Choose the position, size, and working directory of a new pane split.
Environment 1 type
Read and update environment variables used to start processes in tmux.
Commands 7 types, 1 function or constant
Several tmux commands collected to run together in one invocation.
A sequence of tmux commands where each one acts on what the last one made.
The commands this tmux knows, read without starting a server to answer.
Controls the dispatchers and concurrency limits for a Server 's suspending operations.
The server's own message log, newest last.
The server's command-prompt history.
A shell command run by tmux, and a tmux command chosen by a shell command's exit status.
Retries block up to times more times after a DispatchException whose DispatchException.safeToRetry says the exact same request can be sent again.
Control mode 1 type, 3 functions and constants
A tmux client that stays attached and answers one command at a time.
Waits for something to signal this channel.
As await , while preserving process capacity for a call that signals it.
As withServer , for a ControlClient attached through server .
Queries 2 functions and constants
Selects the elements an expression matches.
Inverts an expression, so !Pane_.active().isTrue() says what it means.
Queries — Fields 5 types
Kotlin-idiomatic wrappers over Fields ' typed field handles, each holding the Java handle it wraps. A value class, so this costs nothing beyond the Java object it already holds — the same choice io.github.libtmux.kotlin.Server 's live handles reject, made here on purpose: a field handle carries exactly one property, which is what makes the boxing tradeoff free.
Build numeric comparisons for a captured tmux field.
Match a captured boolean field against true or false.
Match an object by the captured children related to it.
Match an object by one captured related object.
Constants and enums 1 type
Read and update options for the server, session, window, or pane that owns this handle.
By module 8 modules
-
java.util.OptionalInt 1
-
java.util.OptionalLong 1
-
io.github.libtmux.Channel 2
-
io.github.libtmux.kotlin.Iterable 1
-
io.github.libtmux.kotlin.query 5
-
io.github.libtmux.query.FilterExpr 1
-
Types 1