API reference

tmux(1) Server [server_manual].

Wrap fetch_objs : treat a not-yet-started server as empty.

Return True if the error indicates the tmux server is not running.

tmux(1) Session [session_manual].

Raise exception session name invalid, modeled after tmux function.

tmux(1) Window [window_manual].

Used for adjustment in Session.new_window() .

tmux(1) Pane [pane_manual].

Used for adjustment in Pane.split() .

tmux(1) Client [client_manual].

Mixin for manager scoped hooks in tmux.

Scope used with set-option and show-option(s) commands.

Mixin for managing tmux options based on scope.

Convert raw option strings to python types.

Recursively convert values to python types via convert_value .

Explode flat, naive options dict's option arrays.

Explode arrayed option's complex values.

Raise exception if error in option command found.

Process subprocess.stdout options or hook output to flat, naive, untyped dict.

Used for adjustment in resize_window, resize_pane.

Mixin for manager session and server level environment variables in tmux.

Return a synthetic version string when tmux lacks -V.

Return libtmux version is a PEP386 compliant format.

Return tmux version.

Return the tmux version string verbatim, preserving letter suffixes.

Return True if tmux version greater than minimum.

Return True if tmux version greater or equal to minimum.

Return True if tmux version less than minimum.

Return True if tmux version less or equal to minimum.

Return True if tmux meets version requirement. Version >= 3.2a.

Return True if tmux version installed.

Command protocol for tmux command.

Command mixin for tmux command.

Run any tmux(1) command through subprocess.

Minimum tmux version that registers each format token.

Format-token scopes a given tmux list-* subcommand can resolve.

Pick the winlink row tmux would select.

Return True if tmux failed because the -t target does not exist.

Convert a tmux version string into a comparable LooseVersion.

Resolve a format token's scope from its name.

Fetch the single list-* row whose obj_key equals obj_id.

Fetch a listing of raw data from a tmux command.

Return field names and tmux format string filtered by scope and version.

Parse a tmux -F line into a dict keyed by Obj field name.

Return the raw tmux -V version token, letter suffix intact.

Internal signal: this tmux predates the -V flag (pre-1.7).

Base Exception for libtmux Errors.

Raised when a deprecated function, method, or parameter is used.

Application binary for tmux not found.

Raised when the process is not running inside a tmux pane.

A lookup expected one object and matched none.

A lookup expected one object and matched several.

tmux has no object with the id that was asked for.

Raised if tmux below the minimum version to use libtmux.

Root error for any error involving invalid, ambiguous or bad options.

Option unknown to tmux show-option(s) or show-window-option(s).

Unknown color option.

Option invalid to tmux.

Option that could potentially match more than one.

Function timed out without meeting condition.

Error unpacking variable.

If adjustment_direction is set, adjustment must be set.

Requires digit (int or str digit) or a percentage.

Render a QueryList.get lookup back as key=value text.

Raise LibTmuxException tagged with the tmux subcommand on stderr.

Session does not exist in the server.

Disallowed session name for tmux (empty, contains periods or colons).

Any type of window related error.

Multiple active windows.

No active window found.

No windows exist for object.

ValueError for libtmux.Window.resize_window.

Any type of pane related error.

Pane not found.

ValueError for libtmux.Pane.resize_pane .

Kill the tmux daemon on socket_name and unlink the socket file.

Clear out any unnecessary environment variables that could interrupt tests.

Return fixture for .tmux.conf configuration.

Return ControlMode context manager factory.

Temporary /home/ path.

Return default username to set for user_path fixture.

Return new, temporary libtmux.Server .

Return new, temporary libtmux.Session .

Return default session creation parameters.

Create a temporary tmux server that cleans up after itself.

Ensure and return temporary user directory.

Suppress ZSH default message.

tmux hooks data structure.

Context manager that spawns a tmux control-mode client.

Skip default fields in dataclass object representation.

Filter list of object/dictionaries. For small, local datasets.

Support non-sequential indexes while maintaining list -like behavior.

Environment variable tmux exports with socket_path,server_pid,session_id.

Environment variable tmux exports with the pane's id, e.g. %3.

Fetch values in objects and keys, supported nested data.

Return the pane id recorded in $TMUX_PANE.

Check if field lookup key, e.g. "my__path__contains" has comparator, return val.

Return env, defaulting to the live process environment.

Return the tmux socket path recorded in $TMUX.

Container for tmux server options.

Container for tmux session options.

Container for tmux window options.

Container for tmux pane options.

Container for all tmux options (server, session, window, and pane).

Dataclass of generic tmux object.