# API reference

Source: https://libtmux.org/en/py/stable/reference/

> Types, methods, and functions in libtmux for Python.

Browse the Python types and operations for working with tmux. Start with the core objects below, or search for a type or member.

Server 1 type, 2 functions and constants

[Server](https://libtmux.org/en/py/stable/reference/libtmux-server/) class 98 members

tmux(1) Server \[server_manual].

[\_fetch_or_empty](https://libtmux.org/en/py/stable/reference/libtmux-server-_fetch_or_empty/) function

Wrap [`fetch_objs` ](https://libtmux.org/en/py/stable/reference/libtmux-neo-fetch_objs/): treat a not-yet-started server as empty.

[\_is_daemon_not_up_error](https://libtmux.org/en/py/stable/reference/libtmux-server-_is_daemon_not_up_error/) function

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

Session 1 type, 2 functions and constants

[Session](https://libtmux.org/en/py/stable/reference/libtmux-session/) class 248 members

tmux(1) Session \[session_manual].

[SessionDict](https://libtmux.org/en/py/stable/reference/libtmux-common-sessiondict/) constant

[session_check_name](https://libtmux.org/en/py/stable/reference/libtmux-common-session_check_name/) function

Raise exception session name invalid, modeled after tmux function.

Window 2 types, 3 functions and constants

[Window](https://libtmux.org/en/py/stable/reference/libtmux-window/) class 254 members

tmux(1) Window \[window_manual].

[WindowDirection](https://libtmux.org/en/py/stable/reference/libtmux-constants-windowdirection/) class 2 members

Used for *adjustment* in [`Session.new_window()` ](https://libtmux.org/en/py/stable/reference/libtmux-session-new_window/).

[WINDOW_DIRECTION_FLAG_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-window_direction_flag_map/) constant

[WindowDict](https://libtmux.org/en/py/stable/reference/libtmux-common-windowdict/) constant

[WindowOptionDict](https://libtmux.org/en/py/stable/reference/libtmux-common-windowoptiondict/) constant

Pane 2 types, 2 functions and constants

[Pane](https://libtmux.org/en/py/stable/reference/libtmux-pane/) class 257 members

tmux(1) Pane \[pane_manual].

[PaneDirection](https://libtmux.org/en/py/stable/reference/libtmux-constants-panedirection/) class 4 members

Used for *adjustment* in [`Pane.split()` ](https://libtmux.org/en/py/stable/reference/libtmux-pane-split/).

[PANE_DIRECTION_FLAG_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-pane_direction_flag_map/) constant

[PaneDict](https://libtmux.org/en/py/stable/reference/libtmux-common-panedict/) constant

Client 1 type

[Client](https://libtmux.org/en/py/stable/reference/libtmux-client/) class 186 members

tmux(1) Client \[client_manual].

Hooks 1 type, 3 functions and constants

[HooksMixin](https://libtmux.org/en/py/stable/reference/libtmux-hooks-hooksmixin/) class 12 members

Mixin for manager scoped hooks in tmux.

[HOOK_SCOPE_FLAG_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-hook_scope_flag_map/) constant

[HookDict](https://libtmux.org/en/py/stable/reference/libtmux-hooks-hookdict/) constant

[HookValues](https://libtmux.org/en/py/stable/reference/libtmux-hooks-hookvalues/) constant

Options 2 types

[OptionScope](https://libtmux.org/en/py/stable/reference/libtmux-constants-optionscope/) class 4 members

Scope used with [`set-option`](https://libtmux.org/en/tmux/latest/manual/set-option/) and `show-option(s)` commands.

[OptionsMixin](https://libtmux.org/en/py/stable/reference/libtmux-options-optionsmixin/) class 12 members

Mixin for managing tmux options based on scope.

Options — Functions 6 functions and constants

[convert_value](https://libtmux.org/en/py/stable/reference/libtmux-options-convert_value/) function

Convert raw option strings to python types.

[convert_values](https://libtmux.org/en/py/stable/reference/libtmux-options-convert_values/) function

Recursively convert values to python types via [`convert_value` ](https://libtmux.org/en/py/stable/reference/libtmux-options-convert_value/).

[explode_arrays](https://libtmux.org/en/py/stable/reference/libtmux-options-explode_arrays/) function

Explode flat, naive options dict's option arrays.

[explode_complex](https://libtmux.org/en/py/stable/reference/libtmux-options-explode_complex/) function

Explode arrayed option's complex values.

[handle_option_error](https://libtmux.org/en/py/stable/reference/libtmux-options-handle_option_error/) function

Raise exception if error in option command found.

[parse_options_to_dict](https://libtmux.org/en/py/stable/reference/libtmux-options-parse_options_to_dict/) function

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

Options — Constants and variables 11 functions and constants

[\_V](https://libtmux.org/en/py/stable/reference/libtmux-options-_v/) constant

[CommandAliases](https://libtmux.org/en/py/stable/reference/libtmux-options-commandaliases/) constant

[ConvertedValue](https://libtmux.org/en/py/stable/reference/libtmux-options-convertedvalue/) constant

[ConvertedValues](https://libtmux.org/en/py/stable/reference/libtmux-options-convertedvalues/) constant

[ExplodedComplexUntypedOptionsDict](https://libtmux.org/en/py/stable/reference/libtmux-options-explodedcomplexuntypedoptionsdict/) constant

[ExplodedUntypedOptionsDict](https://libtmux.org/en/py/stable/reference/libtmux-options-explodeduntypedoptionsdict/) constant

[OPTION_SCOPE_FLAG_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-option_scope_flag_map/) constant

[OptionDict](https://libtmux.org/en/py/stable/reference/libtmux-options-optiondict/) constant

[TerminalOverride](https://libtmux.org/en/py/stable/reference/libtmux-options-terminaloverride/) constant

[TerminalOverrides](https://libtmux.org/en/py/stable/reference/libtmux-options-terminaloverrides/) constant

[UntypedOptionsDict](https://libtmux.org/en/py/stable/reference/libtmux-options-untypedoptionsdict/) constant

Layout and geometry 1 type, 1 function or constant

[ResizeAdjustmentDirection](https://libtmux.org/en/py/stable/reference/libtmux-constants-resizeadjustmentdirection/) class 4 members

Used for *adjustment* in `resize_window`, `resize_pane`.

[RESIZE_ADJUSTMENT_DIRECTION_FLAG_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-resize_adjustment_direction_flag_map/) constant

Environment 1 type

[EnvironmentMixin](https://libtmux.org/en/py/stable/reference/libtmux-common-environmentmixin/) class 8 members

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

Versions 13 functions and constants

[\_\_version\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__version__/) constant

[TMUX_MAX_VERSION](https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_max_version/) constant

[TMUX_MIN_VERSION](https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_min_version/) constant

[\_no_version_flag_fallback](https://libtmux.org/en/py/stable/reference/libtmux-common-_no_version_flag_fallback/) function

Return a synthetic version string when tmux lacks `-V`.

[get_libtmux_version](https://libtmux.org/en/py/stable/reference/libtmux-common-get_libtmux_version/) function

Return libtmux version is a PEP386 compliant format.

[get_version](https://libtmux.org/en/py/stable/reference/libtmux-common-get_version/) function

Return tmux version.

[get_version_str](https://libtmux.org/en/py/stable/reference/libtmux-common-get_version_str/) function

Return the tmux version string verbatim, preserving letter suffixes.

[has_gt_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_gt_version/) function

Return True if tmux version greater than minimum.

[has_gte_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_gte_version/) function

Return True if tmux version greater or equal to minimum.

[has_lt_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_lt_version/) function

Return True if tmux version less than minimum.

[has_lte_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_lte_version/) function

Return True if tmux version less or equal to minimum.

[has_minimum_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_minimum_version/) function

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

[has_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_version/) function

Return True if tmux version installed.

Commands 3 types

[CmdProtocol](https://libtmux.org/en/py/stable/reference/libtmux-common-cmdprotocol/) class 1 member

Command protocol for tmux command.

[CmdMixin](https://libtmux.org/en/py/stable/reference/libtmux-common-cmdmixin/) class 1 member

Command mixin for tmux command.

[tmux_cmd](https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_cmd/) class 1 member

Run any tmux(1) command through subprocess.

Formats 21 functions and constants

[\_CONTEXT_ONLY_TOKENS](https://libtmux.org/en/py/stable/reference/libtmux-neo-_context_only_tokens/) constant

[\_SCOPE_OVERRIDES](https://libtmux.org/en/py/stable/reference/libtmux-neo-_scope_overrides/) constant

[\_SCOPE_PREFIXES](https://libtmux.org/en/py/stable/reference/libtmux-neo-_scope_prefixes/) constant

[\_UNIVERSAL_TOKENS](https://libtmux.org/en/py/stable/reference/libtmux-neo-_universal_tokens/) constant

[CLIENT_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-client_formats/) constant

[FIELD_VERSION](https://libtmux.org/en/py/stable/reference/libtmux-neo-field_version/) constant

Minimum tmux version that registers each format token.

[FORMAT_SEPARATOR](https://libtmux.org/en/py/stable/reference/libtmux-formats-format_separator/) constant

[OutputRaw](https://libtmux.org/en/py/stable/reference/libtmux-neo-outputraw/) constant

[OutputsRaw](https://libtmux.org/en/py/stable/reference/libtmux-neo-outputsraw/) constant

[PANE_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-pane_formats/) constant

[SCOPES_BY_LIST_CMD](https://libtmux.org/en/py/stable/reference/libtmux-neo-scopes_by_list_cmd/) constant

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

[SESSION_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-session_formats/) constant

[WINDOW_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-window_formats/) constant

[\_best_winlink](https://libtmux.org/en/py/stable/reference/libtmux-neo-_best_winlink/) function

Pick the winlink row tmux would select.

[\_is_target_not_found_error](https://libtmux.org/en/py/stable/reference/libtmux-neo-_is_target_not_found_error/) function

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

[\_normalize_tmux_version](https://libtmux.org/en/py/stable/reference/libtmux-neo-_normalize_tmux_version/) function

Convert a tmux version string into a comparable `LooseVersion`.

[\_token_scope](https://libtmux.org/en/py/stable/reference/libtmux-neo-_token_scope/) function

Resolve a format token's scope from its name.

[fetch_obj](https://libtmux.org/en/py/stable/reference/libtmux-neo-fetch_obj/) function

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

[fetch_objs](https://libtmux.org/en/py/stable/reference/libtmux-neo-fetch_objs/) function

Fetch a listing of raw data from a tmux command.

[get_output_format](https://libtmux.org/en/py/stable/reference/libtmux-neo-get_output_format/) function

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

[parse_output](https://libtmux.org/en/py/stable/reference/libtmux-neo-parse_output/) function

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

Queries 1 function or constant

[\_query_version](https://libtmux.org/en/py/stable/reference/libtmux-common-_query_version/) function

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

Errors 18 types, 2 functions and constants

[\_TmuxVersionUnavailable](https://libtmux.org/en/py/stable/reference/libtmux-common-_tmuxversionunavailable/) exception

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

[LibTmuxException](https://libtmux.org/en/py/stable/reference/libtmux-exc-libtmuxexception/) exception 2 members

Base Exception for libtmux Errors.

[DeprecatedError](https://libtmux.org/en/py/stable/reference/libtmux-exc-deprecatederror/) exception 2 members

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

[TmuxCommandNotFound](https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxcommandnotfound/) exception 2 members

Application binary for tmux not found.

[NotInsideTmux](https://libtmux.org/en/py/stable/reference/libtmux-exc-notinsidetmux/) exception 2 members

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

[ObjectDoesNotExist](https://libtmux.org/en/py/stable/reference/libtmux-exc-objectdoesnotexist/) exception 2 members

A lookup expected one object and matched none.

[MultipleObjectsReturned](https://libtmux.org/en/py/stable/reference/libtmux-exc-multipleobjectsreturned/) exception 2 members

A lookup expected one object and matched several.

[TmuxObjectDoesNotExist](https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxobjectdoesnotexist/) class 2 members

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

[VersionTooLow](https://libtmux.org/en/py/stable/reference/libtmux-exc-versiontoolow/) exception 2 members

Raised if tmux below the minimum version to use libtmux.

[OptionError](https://libtmux.org/en/py/stable/reference/libtmux-exc-optionerror/) exception 2 members

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

[UnknownOption](https://libtmux.org/en/py/stable/reference/libtmux-exc-unknownoption/) exception 2 members

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

[UnknownColorOption](https://libtmux.org/en/py/stable/reference/libtmux-exc-unknowncoloroption/) class 2 members

Unknown color option.

[InvalidOption](https://libtmux.org/en/py/stable/reference/libtmux-exc-invalidoption/) exception 2 members

Option invalid to tmux.

[AmbiguousOption](https://libtmux.org/en/py/stable/reference/libtmux-exc-ambiguousoption/) exception 2 members

Option that could potentially match more than one.

[WaitTimeout](https://libtmux.org/en/py/stable/reference/libtmux-exc-waittimeout/) exception 2 members

Function timed out without meeting condition.

[VariableUnpackingError](https://libtmux.org/en/py/stable/reference/libtmux-exc-variableunpackingerror/) exception 2 members

Error unpacking variable.

[AdjustmentDirectionRequiresAdjustment](https://libtmux.org/en/py/stable/reference/libtmux-exc-adjustmentdirectionrequiresadjustment/) exception 2 members

If *adjustment_direction* is set, *adjustment* must be set.

[RequiresDigitOrPercentage](https://libtmux.org/en/py/stable/reference/libtmux-exc-requiresdigitorpercentage/) exception 2 members

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

[\_format_query](https://libtmux.org/en/py/stable/reference/libtmux-exc-_format_query/) function

Render a [`QueryList.get` ](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-querylist-get/)lookup back as `key=value` text.

[raise_if_stderr](https://libtmux.org/en/py/stable/reference/libtmux-common-raise_if_stderr/) function

Raise [`LibTmuxException` ](https://libtmux.org/en/py/stable/reference/libtmux-exc-libtmuxexception/)tagged with the tmux subcommand on stderr.

Errors — Session 2 types

[TmuxSessionExists](https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxsessionexists/) exception 2 members

Session does not exist in the server.

[BadSessionName](https://libtmux.org/en/py/stable/reference/libtmux-exc-badsessionname/) exception 2 members

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

Errors — Window 5 types

[WindowError](https://libtmux.org/en/py/stable/reference/libtmux-exc-windowerror/) exception 2 members

Any type of window related error.

[MultipleActiveWindows](https://libtmux.org/en/py/stable/reference/libtmux-exc-multipleactivewindows/) exception 2 members

Multiple active windows.

[NoActiveWindow](https://libtmux.org/en/py/stable/reference/libtmux-exc-noactivewindow/) exception 2 members

No active window found.

[NoWindowsExist](https://libtmux.org/en/py/stable/reference/libtmux-exc-nowindowsexist/) exception 2 members

No windows exist for object.

[WindowAdjustmentDirectionRequiresAdjustment](https://libtmux.org/en/py/stable/reference/libtmux-exc-windowadjustmentdirectionrequiresadjustment/) exception 2 members

ValueError for `libtmux.Window.resize_window`.

Errors — Pane 3 types

[PaneError](https://libtmux.org/en/py/stable/reference/libtmux-exc-paneerror/) exception 2 members

Any type of pane related error.

[PaneNotFound](https://libtmux.org/en/py/stable/reference/libtmux-exc-panenotfound/) exception 2 members

Pane not found.

[PaneAdjustmentDirectionRequiresAdjustment](https://libtmux.org/en/py/stable/reference/libtmux-exc-paneadjustmentdirectionrequiresadjustment/) exception 2 members

ValueError for [`libtmux.Pane.resize_pane` ](https://libtmux.org/en/py/stable/reference/libtmux-pane-resize_pane/).

Testing utilities 13 functions and constants

[USING_ZSH](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-using_zsh/) constant

[\_reap_test_server](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-_reap_test_server/) function

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

[clear_env](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-clear_env/) function

Clear out any unnecessary environment variables that could interrupt tests.

[config_file](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-config_file/) function

Return fixture for `.tmux.conf` configuration.

[control_mode](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-control_mode/) function

Return [`ControlMode` ](https://libtmux.org/en/py/stable/reference/libtmux-_internal-control_mode-controlmode/)context manager factory.

[home_path](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-home_path/) function

Temporary `/home/` path.

[home_user_name](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-home_user_name/) function

Return default username to set for user_path fixture.

[server](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-server/) function

Return new, temporary [`libtmux.Server` ](https://libtmux.org/en/py/stable/reference/libtmux-server/).

[session](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-session/) function

Return new, temporary [`libtmux.Session` ](https://libtmux.org/en/py/stable/reference/libtmux-session/).

[session_params](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-session_params/) function

Return default session creation parameters.

[TestServer](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-testserver/) function

Create a temporary tmux server that cleans up after itself.

[user_path](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-user_path/) function

Ensure and return temporary user directory.

[zshrc](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-zshrc/) function

Suppress ZSH default message.

Internal 7 types, 51 functions and constants

[Hooks](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-hooks/) class 92 members

tmux hooks data structure.

[ControlMode](https://libtmux.org/en/py/stable/reference/libtmux-_internal-control_mode-controlmode/) class 9 members

Context manager that spawns a tmux control-mode client.

[SkipDefaultFieldsReprMixin](https://libtmux.org/en/py/stable/reference/libtmux-_internal-dataclasses-skipdefaultfieldsreprmixin/) class 1 member

Skip default fields in [`dataclass` ](https://docs.python.org/3/library/dataclasses.html#dataclasses.dataclass)object representation.

[PKRequiredException](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-pkrequiredexception/) exception 1 member

[OpNotFound](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-opnotfound/) exception 1 member

[QueryList](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-querylist/) class 7 members

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

[SparseArray](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-sparsearray/) class 4 members

Support non-sequential indexes while maintaining [`list` ](https://docs.python.org/3/library/stdtypes.html#list)-like behavior.

[\_\_author\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__author__/) constant

[\_\_copyright\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__copyright__/) constant

[\_\_description\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__description__/) constant

[\_\_docs\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__docs__/) constant

[\_\_email\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__email__/) constant

[\_\_github\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__github__/) constant

[\_\_license\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__license__/) constant

[\_\_package_name\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__package_name__/) constant

[\_\_pypi\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__pypi__/) constant

[\_\_title\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__title__/) constant

[\_\_tracker\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__tracker__/) constant

[HookArray](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-hookarray/) constant In libtmux.\_internal.constants

[HookArray](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-hookarray/) constant In libtmux.\_internal.sparse_array

[logger](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-logger/) constant In libtmux.\_internal.query_list

[logger](https://libtmux.org/en/py/stable/reference/libtmux-client-logger/) constant In libtmux.client

[logger](https://libtmux.org/en/py/stable/reference/libtmux-common-logger/) constant In libtmux.common

[logger](https://libtmux.org/en/py/stable/reference/libtmux-hooks-logger/) constant In libtmux.hooks

[logger](https://libtmux.org/en/py/stable/reference/libtmux-neo-logger/) constant In libtmux.neo

[logger](https://libtmux.org/en/py/stable/reference/libtmux-options-logger/) constant In libtmux.options

[logger](https://libtmux.org/en/py/stable/reference/libtmux-pane-logger/) constant In libtmux.pane

[logger](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-logger/) constant In libtmux.pytest_plugin

[logger](https://libtmux.org/en/py/stable/reference/libtmux-server-logger/) constant In libtmux.server

[logger](https://libtmux.org/en/py/stable/reference/libtmux-session-logger/) constant In libtmux.session

[logger](https://libtmux.org/en/py/stable/reference/libtmux-window-logger/) constant In libtmux.window

[LOOKUP_NAME_MAP](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_name_map/) constant

[no_arg](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-no_arg/) constant

[StrPath](https://libtmux.org/en/py/stable/reference/libtmux-_internal-types-strpath/) constant

[T](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-t/) constant In libtmux.\_internal.constants

[T](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-t/) constant In libtmux.\_internal.query_list

[T](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-t/) constant In libtmux.\_internal.sparse_array

[TerminalFeatures](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-terminalfeatures/) constant

[TMUX](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-tmux/) constant

Environment variable tmux exports with `socket_path,server_pid,session_id`.

[TMUX_PANE](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-tmux_pane/) constant

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

[is_sparse_array_list](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-is_sparse_array_list/) function

[keygetter](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-keygetter/) function

Fetch values in objects and keys, supported nested data.

[lookup_contains](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_contains/) function

[lookup_endswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_endswith/) function

[lookup_exact](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_exact/) function

[lookup_icontains](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_icontains/) function

[lookup_iendswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iendswith/) function

[lookup_iexact](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iexact/) function

[lookup_in](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_in/) function

[lookup_iregex](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iregex/) function

[lookup_istartswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_istartswith/) function

[lookup_nin](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_nin/) function

[lookup_regex](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_regex/) function

[lookup_startswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_startswith/) function

[pane_id_from_env](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-pane_id_from_env/) function

Return the pane id recorded in `$TMUX_PANE`.

[parse_lookup](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-parse_lookup/) function

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

[resolve_env](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-resolve_env/) function

Return *env*, defaulting to the live process environment.

[socket_path_from_env](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-socket_path_from_env/) function

Return the tmux socket path recorded in `$TMUX`.

Internal — Options 5 types

[ServerOptions](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-serveroptions/) class 23 members

Container for tmux server options.

[SessionOptions](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-sessionoptions/) class 55 members

Container for tmux session options.

[WindowOptions](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-windowoptions/) class 48 members

Container for tmux window options.

[PaneOptions](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-paneoptions/) class 19 members

Container for tmux pane options.

[Options](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-options/) class 136 members

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

Other 2 types, 2 functions and constants

[\_DefaultOptionScope](https://libtmux.org/en/py/stable/reference/libtmux-constants-_defaultoptionscope/) class

[Obj](https://libtmux.org/en/py/stable/reference/libtmux-neo-obj/) class 180 members

Dataclass of generic tmux object.

[\_\_all\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__all__/) constant

[DEFAULT_OPTION_SCOPE](https://libtmux.org/en/py/stable/reference/libtmux-constants-default_option_scope/) constant

## By module 73 modules

* libtmux 14

  * [Client](https://libtmux.org/en/py/stable/reference/libtmux-client/)
  * [Pane](https://libtmux.org/en/py/stable/reference/libtmux-pane/)
  * [Server](https://libtmux.org/en/py/stable/reference/libtmux-server/)
  * [Session](https://libtmux.org/en/py/stable/reference/libtmux-session/)
  * [Window](https://libtmux.org/en/py/stable/reference/libtmux-window/)
  * [\_​_all​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__all__/)
  * [\_​_author​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__author__/)
  * [\_​_copyright​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__copyright__/)
  * [\_​_description​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__description__/)
  * [\_​_email​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__email__/)
  * [\_​_license​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__license__/)
  * [\_​_package​_name​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__package_name__/)
  * [\_​_title​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__title__/)
  * [\_​_version​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__version__/)

* libtmux_mcp 1

  * [main](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-main/)

* libtmux_mcp.middleware 6

  * [Audit​Middleware](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-middleware-auditmiddleware/)
  * [Tail​Preserving​Response​Limiting​Middleware](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-middleware-tailpreservingresponselimitingmiddleware/)
  * [Tool​Error​Result​Middleware](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-middleware-toolerrorresultmiddleware/)
  * [Toolset​Middleware](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-middleware-toolsetmiddleware/)
  * [DEFAULT​_RESPONSE​_LIMIT​_BYTES](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-middleware-default_response_limit_bytes/)
  * [install​_fastmcp​_validation​_log​_filter](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-middleware-install_fastmcp_validation_log_filter/)

* libtmux_mcp.models 24

  * [Buffer​Content](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-buffercontent/)
  * [Buffer​Ref](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-bufferref/)
  * [Capture​Since​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-capturesinceresult/)
  * [Environment​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-environmentresult/)
  * [Environment​Set​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-environmentsetresult/)
  * [Hook​Entry](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-hookentry/)
  * [Hook​List​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-hooklistresult/)
  * [Option​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-optionresult/)
  * [Option​Set​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-optionsetresult/)
  * [Pane​Content​Match](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-panecontentmatch/)
  * [Pane​Info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-paneinfo/)
  * [Pane​Snapshot](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-panesnapshot/)
  * [Run​Command​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-runcommandresult/)
  * [Search​Panes​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-searchpanesresult/)
  * [Send​Keys​Batch​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-sendkeysbatchresult/)
  * [Send​Keys​Operation](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-sendkeysoperation/)
  * [Send​Keys​Operation​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-sendkeysoperationresult/)
  * [Server​Info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-serverinfo/)
  * [Session​Info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-sessioninfo/)
  * [Tool​Call​Batch​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-toolcallbatchresult/)
  * [Tool​Call​Operation](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-toolcalloperation/)
  * [Tool​Call​Operation​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-toolcalloperationresult/)
  * [Wait​For​Text​Result](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-waitfortextresult/)
  * [Window​Info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-models-windowinfo/)

* libtmux_mcp.prompts 2

  * [ENV​_PROMPTS​_AS​_TOOLS](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-prompts-env_prompts_as_tools/)
  * [register​_prompts](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-prompts-register_prompts/)

* libtmux_mcp.resources 1

  * [register​_resources](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-resources-register_resources/)

* libtmux_mcp.server 4

  * [DEFAULT​_TOOLSETS](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-server-default_toolsets/)
  * [mcp](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-server-mcp/)
  * [build​_mcp​_server](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-server-build_mcp_server/)
  * [run​_server](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-server-run_server/)

* libtmux_mcp.tools 1

  * [register​_tools](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-register_tools/)

* libtmux.\_\_about\_\_ 4

  * [\_​_docs​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__docs__/)
  * [\_​_github​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__github__/)
  * [\_​_pypi​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__pypi__/)
  * [\_​_tracker​\_\_](https://libtmux.org/en/py/stable/reference/libtmux-__about__-__tracker__/)

* libtmux.client 1

  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-client-logger/)

* libtmux.common 25

  * [Cmd​Mixin](https://libtmux.org/en/py/stable/reference/libtmux-common-cmdmixin/)
  * [Cmd​Protocol](https://libtmux.org/en/py/stable/reference/libtmux-common-cmdprotocol/)
  * [Environment​Mixin](https://libtmux.org/en/py/stable/reference/libtmux-common-environmentmixin/)
  * [tmux​_cmd](https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_cmd/)
  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-common-logger/)
  * [Pane​Dict](https://libtmux.org/en/py/stable/reference/libtmux-common-panedict/)
  * [Session​Dict](https://libtmux.org/en/py/stable/reference/libtmux-common-sessiondict/)
  * [TMUX​_MAX​_VERSION](https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_max_version/)
  * [TMUX​_MIN​_VERSION](https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_min_version/)
  * [Window​Dict](https://libtmux.org/en/py/stable/reference/libtmux-common-windowdict/)
  * [Window​Option​Dict](https://libtmux.org/en/py/stable/reference/libtmux-common-windowoptiondict/)
  * [\_Tmux​Version​Unavailable](https://libtmux.org/en/py/stable/reference/libtmux-common-_tmuxversionunavailable/)
  * [\_no​_version​_flag​_fallback](https://libtmux.org/en/py/stable/reference/libtmux-common-_no_version_flag_fallback/)
  * [\_query​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-_query_version/)
  * [get​_libtmux​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-get_libtmux_version/)
  * [get​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-get_version/)
  * [get​_version​_str](https://libtmux.org/en/py/stable/reference/libtmux-common-get_version_str/)
  * [has​_gt​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_gt_version/)
  * [has​_gte​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_gte_version/)
  * [has​_lt​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_lt_version/)
  * [has​_lte​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_lte_version/)
  * [has​_minimum​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_minimum_version/)
  * [has​_version](https://libtmux.org/en/py/stable/reference/libtmux-common-has_version/)
  * [raise​_if​_stderr](https://libtmux.org/en/py/stable/reference/libtmux-common-raise_if_stderr/)
  * [session​_check​_name](https://libtmux.org/en/py/stable/reference/libtmux-common-session_check_name/)

* libtmux.constants 11

  * [Option​Scope](https://libtmux.org/en/py/stable/reference/libtmux-constants-optionscope/)
  * [Pane​Direction](https://libtmux.org/en/py/stable/reference/libtmux-constants-panedirection/)
  * [Resize​Adjustment​Direction](https://libtmux.org/en/py/stable/reference/libtmux-constants-resizeadjustmentdirection/)
  * [Window​Direction](https://libtmux.org/en/py/stable/reference/libtmux-constants-windowdirection/)
  * [\_Default​Option​Scope](https://libtmux.org/en/py/stable/reference/libtmux-constants-_defaultoptionscope/)
  * [DEFAULT​_OPTION​_SCOPE](https://libtmux.org/en/py/stable/reference/libtmux-constants-default_option_scope/)
  * [HOOK​_SCOPE​_FLAG​_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-hook_scope_flag_map/)
  * [OPTION​_SCOPE​_FLAG​_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-option_scope_flag_map/)
  * [PANE​_DIRECTION​_FLAG​_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-pane_direction_flag_map/)
  * [RESIZE​_ADJUSTMENT​_DIRECTION​_FLAG​_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-resize_adjustment_direction_flag_map/)
  * [WINDOW​_DIRECTION​_FLAG​_MAP](https://libtmux.org/en/py/stable/reference/libtmux-constants-window_direction_flag_map/)

* libtmux.exc 28

  * [Tmux​Object​Does​Not​Exist](https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxobjectdoesnotexist/)
  * [Unknown​Color​Option](https://libtmux.org/en/py/stable/reference/libtmux-exc-unknowncoloroption/)
  * [Adjustment​Direction​Requires​Adjustment](https://libtmux.org/en/py/stable/reference/libtmux-exc-adjustmentdirectionrequiresadjustment/)
  * [Ambiguous​Option](https://libtmux.org/en/py/stable/reference/libtmux-exc-ambiguousoption/)
  * [Bad​Session​Name](https://libtmux.org/en/py/stable/reference/libtmux-exc-badsessionname/)
  * [Deprecated​Error](https://libtmux.org/en/py/stable/reference/libtmux-exc-deprecatederror/)
  * [Invalid​Option](https://libtmux.org/en/py/stable/reference/libtmux-exc-invalidoption/)
  * [Lib​Tmux​Exception](https://libtmux.org/en/py/stable/reference/libtmux-exc-libtmuxexception/)
  * [Multiple​Active​Windows](https://libtmux.org/en/py/stable/reference/libtmux-exc-multipleactivewindows/)
  * [Multiple​Objects​Returned](https://libtmux.org/en/py/stable/reference/libtmux-exc-multipleobjectsreturned/)
  * [No​Active​Window](https://libtmux.org/en/py/stable/reference/libtmux-exc-noactivewindow/)
  * [Not​Inside​Tmux](https://libtmux.org/en/py/stable/reference/libtmux-exc-notinsidetmux/)
  * [No​Windows​Exist](https://libtmux.org/en/py/stable/reference/libtmux-exc-nowindowsexist/)
  * [Object​Does​Not​Exist](https://libtmux.org/en/py/stable/reference/libtmux-exc-objectdoesnotexist/)
  * [Option​Error](https://libtmux.org/en/py/stable/reference/libtmux-exc-optionerror/)
  * [Pane​Adjustment​Direction​Requires​Adjustment](https://libtmux.org/en/py/stable/reference/libtmux-exc-paneadjustmentdirectionrequiresadjustment/)
  * [Pane​Error](https://libtmux.org/en/py/stable/reference/libtmux-exc-paneerror/)
  * [Pane​Not​Found](https://libtmux.org/en/py/stable/reference/libtmux-exc-panenotfound/)
  * [Requires​Digit​Or​Percentage](https://libtmux.org/en/py/stable/reference/libtmux-exc-requiresdigitorpercentage/)
  * [Tmux​Command​Not​Found](https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxcommandnotfound/)
  * [Tmux​Session​Exists](https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxsessionexists/)
  * [Unknown​Option](https://libtmux.org/en/py/stable/reference/libtmux-exc-unknownoption/)
  * [Variable​Unpacking​Error](https://libtmux.org/en/py/stable/reference/libtmux-exc-variableunpackingerror/)
  * [Version​Too​Low](https://libtmux.org/en/py/stable/reference/libtmux-exc-versiontoolow/)
  * [Wait​Timeout](https://libtmux.org/en/py/stable/reference/libtmux-exc-waittimeout/)
  * [Window​Adjustment​Direction​Requires​Adjustment](https://libtmux.org/en/py/stable/reference/libtmux-exc-windowadjustmentdirectionrequiresadjustment/)
  * [Window​Error](https://libtmux.org/en/py/stable/reference/libtmux-exc-windowerror/)
  * [\_format​_query](https://libtmux.org/en/py/stable/reference/libtmux-exc-_format_query/)

* libtmux.formats 5

  * [CLIENT​_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-client_formats/)
  * [FORMAT​_SEPARATOR](https://libtmux.org/en/py/stable/reference/libtmux-formats-format_separator/)
  * [PANE​_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-pane_formats/)
  * [SESSION​_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-session_formats/)
  * [WINDOW​_FORMATS](https://libtmux.org/en/py/stable/reference/libtmux-formats-window_formats/)

* libtmux.hooks 4

  * [Hooks​Mixin](https://libtmux.org/en/py/stable/reference/libtmux-hooks-hooksmixin/)
  * [Hook​Dict](https://libtmux.org/en/py/stable/reference/libtmux-hooks-hookdict/)
  * [Hook​Values](https://libtmux.org/en/py/stable/reference/libtmux-hooks-hookvalues/)
  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-hooks-logger/)

* libtmux.neo 18

  * [Obj](https://libtmux.org/en/py/stable/reference/libtmux-neo-obj/)
  * [\_CONTEXT​_ONLY​_TOKENS](https://libtmux.org/en/py/stable/reference/libtmux-neo-_context_only_tokens/)
  * [\_SCOPE​_OVERRIDES](https://libtmux.org/en/py/stable/reference/libtmux-neo-_scope_overrides/)
  * [\_SCOPE​_PREFIXES](https://libtmux.org/en/py/stable/reference/libtmux-neo-_scope_prefixes/)
  * [\_UNIVERSAL​_TOKENS](https://libtmux.org/en/py/stable/reference/libtmux-neo-_universal_tokens/)
  * [FIELD​_VERSION](https://libtmux.org/en/py/stable/reference/libtmux-neo-field_version/)
  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-neo-logger/)
  * [Output​Raw](https://libtmux.org/en/py/stable/reference/libtmux-neo-outputraw/)
  * [Outputs​Raw](https://libtmux.org/en/py/stable/reference/libtmux-neo-outputsraw/)
  * [SCOPES​_BY​_LIST​_CMD](https://libtmux.org/en/py/stable/reference/libtmux-neo-scopes_by_list_cmd/)
  * [\_best​_winlink](https://libtmux.org/en/py/stable/reference/libtmux-neo-_best_winlink/)
  * [\_is​_target​_not​_found​_error](https://libtmux.org/en/py/stable/reference/libtmux-neo-_is_target_not_found_error/)
  * [\_normalize​_tmux​_version](https://libtmux.org/en/py/stable/reference/libtmux-neo-_normalize_tmux_version/)
  * [\_token​_scope](https://libtmux.org/en/py/stable/reference/libtmux-neo-_token_scope/)
  * [fetch​_obj](https://libtmux.org/en/py/stable/reference/libtmux-neo-fetch_obj/)
  * [fetch​_objs](https://libtmux.org/en/py/stable/reference/libtmux-neo-fetch_objs/)
  * [get​_output​_format](https://libtmux.org/en/py/stable/reference/libtmux-neo-get_output_format/)
  * [parse​_output](https://libtmux.org/en/py/stable/reference/libtmux-neo-parse_output/)

* libtmux.options 18

  * [Options​Mixin](https://libtmux.org/en/py/stable/reference/libtmux-options-optionsmixin/)
  * [\_V](https://libtmux.org/en/py/stable/reference/libtmux-options-_v/)
  * [Command​Aliases](https://libtmux.org/en/py/stable/reference/libtmux-options-commandaliases/)
  * [Converted​Value](https://libtmux.org/en/py/stable/reference/libtmux-options-convertedvalue/)
  * [Converted​Values](https://libtmux.org/en/py/stable/reference/libtmux-options-convertedvalues/)
  * [Exploded​Complex​Untyped​Options​Dict](https://libtmux.org/en/py/stable/reference/libtmux-options-explodedcomplexuntypedoptionsdict/)
  * [Exploded​Untyped​Options​Dict](https://libtmux.org/en/py/stable/reference/libtmux-options-explodeduntypedoptionsdict/)
  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-options-logger/)
  * [Option​Dict](https://libtmux.org/en/py/stable/reference/libtmux-options-optiondict/)
  * [Terminal​Override](https://libtmux.org/en/py/stable/reference/libtmux-options-terminaloverride/)
  * [Terminal​Overrides](https://libtmux.org/en/py/stable/reference/libtmux-options-terminaloverrides/)
  * [Untyped​Options​Dict](https://libtmux.org/en/py/stable/reference/libtmux-options-untypedoptionsdict/)
  * [convert​_value](https://libtmux.org/en/py/stable/reference/libtmux-options-convert_value/)
  * [convert​_values](https://libtmux.org/en/py/stable/reference/libtmux-options-convert_values/)
  * [explode​_arrays](https://libtmux.org/en/py/stable/reference/libtmux-options-explode_arrays/)
  * [explode​_complex](https://libtmux.org/en/py/stable/reference/libtmux-options-explode_complex/)
  * [handle​_option​_error](https://libtmux.org/en/py/stable/reference/libtmux-options-handle_option_error/)
  * [parse​_options​_to​_dict](https://libtmux.org/en/py/stable/reference/libtmux-options-parse_options_to_dict/)

* libtmux.pane 1

  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-pane-logger/)

* libtmux.pytest_plugin 14

  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-logger/)
  * [USING​_ZSH](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-using_zsh/)
  * [\_reap​_test​_server](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-_reap_test_server/)
  * [clear​_env](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-clear_env/)
  * [config​_file](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-config_file/)
  * [control​_mode](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-control_mode/)
  * [home​_path](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-home_path/)
  * [home​_user​_name](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-home_user_name/)
  * [server](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-server/)
  * [session](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-session/)
  * [session​_params](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-session_params/)
  * [Test​Server](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-testserver/)
  * [user​_path](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-user_path/)
  * [zshrc](https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-zshrc/)

* libtmux.server 3

  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-server-logger/)
  * [\_fetch​_or​_empty](https://libtmux.org/en/py/stable/reference/libtmux-server-_fetch_or_empty/)
  * [\_is​_daemon​_not​_up​_error](https://libtmux.org/en/py/stable/reference/libtmux-server-_is_daemon_not_up_error/)

* libtmux.session 1

  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-session-logger/)

* libtmux.window 1

  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-window-logger/)

* tmuxp.cli 7

  * [CLINamespace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-clinamespace/)
  * [CLI​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-cli_description/)
  * [ns](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-ns/)
  * [cli](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-cli/)
  * [create​_parser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-create_parser/)
  * [setup​_logger](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-setup_logger/)
  * [startup](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-startup/)

* tmuxp.exc 17

  * [Active​Session​Missing​Workspace​Exception](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-activesessionmissingworkspaceexception/)
  * [Before​Load​Script​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-beforeloadscripterror/)
  * [Before​Load​Script​Not​Exists](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-beforeloadscriptnotexists/)
  * [Empty​Workspace​Exception](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-emptyworkspaceexception/)
  * [Invalid​Workspace​Builder](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-invalidworkspacebuilder/)
  * [Invalid​Workspace​Builder​Option](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-invalidworkspacebuilderoption/)
  * [Pane​Not​Found](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-panenotfound/)
  * [Session​Missing​Workspace​Exception](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-sessionmissingworkspaceexception/)
  * [Session​Not​Found](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-sessionnotfound/)
  * [Window​Not​Found](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-windownotfound/)
  * [Workspace​Builder​Import​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-workspacebuilderimporterror/)
  * [Workspace​Builder​Not​Found](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-workspacebuildernotfound/)
  * [Workspace​Builder​Path​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-workspacebuilderpatherror/)
  * [Tmuxp​Exception](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-tmuxpexception/)
  * [Tmuxp​Plugin​Exception](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-tmuxppluginexception/)
  * [Workspace​Builder​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-workspacebuildererror/)
  * [Workspace​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-workspaceerror/)

* tmuxp.log 8

  * [Debug​Log​Formatter](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-debuglogformatter/)
  * [Log​Formatter](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-logformatter/)
  * [Tmuxp​Logger​Adapter](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-tmuxploggeradapter/)
  * [LEVEL​_COLORS](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-level_colors/)
  * [debug​_log​_template](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-debug_log_template/)
  * [set​_style](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-set_style/)
  * [setup​_log​_file](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-setup_log_file/)
  * [tmuxp​_echo](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-log-tmuxp_echo/)

* tmuxp.plugin 11

  * [Config](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-config/)
  * [Tmuxp​Plugin](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-tmuxpplugin/)
  * [DEFAULT​_CONFIG](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-default_config/)
  * [LIBTMUX​_MAX​_VERSION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-libtmux_max_version/)
  * [LIBTMUX​_MIN​_VERSION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-libtmux_min_version/)
  * [TMUX​_MAX​_VERSION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-tmux_max_version/)
  * [TMUX​_MIN​_VERSION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-tmux_min_version/)
  * [TMUXP​_MAX​_VERSION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-tmuxp_max_version/)
  * [TMUXP​_MIN​_VERSION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-tmuxp_min_version/)
  * [setup​_plugin​_config](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-setup_plugin_config/)
  * [validate​_plugin​_config](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-plugin-validate_plugin_config/)

* tmuxp.shell 13

  * [detect​_best​_shell](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-detect_best_shell/)
  * [get​_bpython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-get_bpython/)
  * [get​_code](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-get_code/)
  * [get​_ipython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-get_ipython/)
  * [get​_ipython​_arguments](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-get_ipython_arguments/)
  * [get​_launch​_args](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-get_launch_args/)
  * [get​_ptipython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-get_ptipython/)
  * [get​_ptpython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-get_ptpython/)
  * [has​_bpython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-has_bpython/)
  * [has​_ipython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-has_ipython/)
  * [has​_ptipython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-has_ptipython/)
  * [has​_ptpython](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-has_ptpython/)
  * [launch](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-shell-launch/)

* tmuxp.types 1

  * [Str​Path](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-types-strpath/)

* tmuxp.util 7

  * [PY2](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-util-py2/)
  * [get​_current​_pane](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-util-get_current_pane/)
  * [get​_pane](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-util-get_pane/)
  * [get​_session](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-util-get_session/)
  * [get​_window](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-util-get_window/)
  * [oh​_my​_zsh​_auto​_title](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-util-oh_my_zsh_auto_title/)
  * [run​_before​_script](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-util-run_before_script/)

* libtmux_mcp.prompts.recipes 4

  * [build​_dev​_workspace](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-prompts-recipes-build_dev_workspace/)
  * [diagnose​_failing​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-prompts-recipes-diagnose_failing_pane/)
  * [interrupt​_gracefully](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-prompts-recipes-interrupt_gracefully/)
  * [run​_and​_wait](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-prompts-recipes-run_and_wait/)

* libtmux_mcp.resources.hierarchy 2

  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-resources-hierarchy-register/)
  * [register​_completions](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-resources-hierarchy-register_completions/)

* libtmux_mcp.tools.batch_tools 3

  * [MAX​_BATCH​_OPERATIONS](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-batch_tools-max_batch_operations/)
  * [call​_read​_tools​_batch](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-batch_tools-call_read_tools_batch/)
  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-batch_tools-register/)

* libtmux_mcp.tools.buffer_tools 6

  * [SHOW​_BUFFER​_DEFAULT​_MAX​_LINES](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-buffer_tools-show_buffer_default_max_lines/)
  * [delete​_buffer](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-buffer_tools-delete_buffer/)
  * [load​_buffer](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-buffer_tools-load_buffer/)
  * [paste​_buffer](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-buffer_tools-paste_buffer/)
  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-buffer_tools-register/)
  * [show​_buffer](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-buffer_tools-show_buffer/)

* libtmux_mcp.tools.env_tools 3

  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-env_tools-register/)
  * [set​_environment](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-env_tools-set_environment/)
  * [show​_environment](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-env_tools-show_environment/)

* libtmux_mcp.tools.hook_tools 3

  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-hook_tools-register/)
  * [show​_hook](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-hook_tools-show_hook/)
  * [show​_hooks](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-hook_tools-show_hooks/)

* libtmux_mcp.tools.option_tools 3

  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-option_tools-register/)
  * [set​_option](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-option_tools-set_option/)
  * [show​_option](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-option_tools-show_option/)

* libtmux_mcp.tools.pane_tools 23

  * [capture​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-capture_pane/)
  * [capture​_since](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-capture_since/)
  * [clear​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-clear_pane/)
  * [display​_message](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-display_message/)
  * [enter​_copy​_mode](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-enter_copy_mode/)
  * [exit​_copy​_mode](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-exit_copy_mode/)
  * [find​_pane​_by​_position](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-find_pane_by_position/)
  * [get​_pane​_info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-get_pane_info/)
  * [kill​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-kill_pane/)
  * [paste​_text](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-paste_text/)
  * [pipe​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-pipe_pane/)
  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-register/)
  * [resize​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-resize_pane/)
  * [respawn​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-respawn_pane/)
  * [run​_command](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-run_command/)
  * [search​_panes](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-search_panes/)
  * [select​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-select_pane/)
  * [send​_keys](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-send_keys/)
  * [send​_keys​_batch](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-send_keys_batch/)
  * [set​_pane​_title](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-set_pane_title/)
  * [snapshot​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-snapshot_pane/)
  * [swap​_pane](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-swap_pane/)
  * [wait​_for​_text](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-wait_for_text/)

* libtmux_mcp.tools.server_tools 7

  * [SOCKET​_NAME​_EXEMPT](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-server_tools-socket_name_exempt/)
  * [create​_session](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-server_tools-create_session/)
  * [get​_server​_info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-server_tools-get_server_info/)
  * [kill​_server](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-server_tools-kill_server/)
  * [list​_servers](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-server_tools-list_servers/)
  * [list​_sessions](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-server_tools-list_sessions/)
  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-server_tools-register/)

* libtmux_mcp.tools.session_tools 7

  * [create​_window](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-session_tools-create_window/)
  * [get​_session​_info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-session_tools-get_session_info/)
  * [kill​_session](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-session_tools-kill_session/)
  * [list​_windows](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-session_tools-list_windows/)
  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-session_tools-register/)
  * [rename​_session](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-session_tools-rename_session/)
  * [select​_window](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-session_tools-select_window/)

* libtmux_mcp.tools.wait_for_tools 3

  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-wait_for_tools-register/)
  * [signal​_channel](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-wait_for_tools-signal_channel/)
  * [wait​_for​_channel](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-wait_for_tools-wait_for_channel/)

* libtmux_mcp.tools.window_tools 9

  * [get​_window​_info](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-get_window_info/)
  * [kill​_window](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-kill_window/)
  * [list​_panes](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-list_panes/)
  * [move​_window](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-move_window/)
  * [register](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-register/)
  * [rename​_window](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-rename_window/)
  * [resize​_window](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-resize_window/)
  * [select​_layout](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-select_layout/)
  * [split​_window](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-window_tools-split_window/)

* libtmux.\_internal.constants 9

  * [Hooks](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-hooks/)
  * [Options](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-options/)
  * [Pane​Options](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-paneoptions/)
  * [Server​Options](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-serveroptions/)
  * [Session​Options](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-sessionoptions/)
  * [Window​Options](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-windowoptions/)
  * [Hook​Array](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-hookarray/)
  * [T](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-t/)
  * [Terminal​Features](https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-terminalfeatures/)

* libtmux.\_internal.control_mode 1

  * [Control​Mode](https://libtmux.org/en/py/stable/reference/libtmux-_internal-control_mode-controlmode/)

* libtmux.\_internal.dataclasses 1

  * [Skip​Default​Fields​Repr​Mixin](https://libtmux.org/en/py/stable/reference/libtmux-_internal-dataclasses-skipdefaultfieldsreprmixin/)

* libtmux.\_internal.env 5

  * [TMUX](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-tmux/)
  * [TMUX​_PANE](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-tmux_pane/)
  * [pane​_id​_from​_env](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-pane_id_from_env/)
  * [resolve​_env](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-resolve_env/)
  * [socket​_path​_from​_env](https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-socket_path_from_env/)

* libtmux.\_internal.query_list 21

  * [Query​List](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-querylist/)
  * [Op​Not​Found](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-opnotfound/)
  * [PKRequired​Exception](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-pkrequiredexception/)
  * [logger](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-logger/)
  * [LOOKUP​_NAME​_MAP](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_name_map/)
  * [no​_arg](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-no_arg/)
  * [T](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-t/)
  * [keygetter](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-keygetter/)
  * [lookup​_contains](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_contains/)
  * [lookup​_endswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_endswith/)
  * [lookup​_exact](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_exact/)
  * [lookup​_icontains](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_icontains/)
  * [lookup​_iendswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iendswith/)
  * [lookup​_iexact](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iexact/)
  * [lookup​_in](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_in/)
  * [lookup​_iregex](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iregex/)
  * [lookup​_istartswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_istartswith/)
  * [lookup​_nin](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_nin/)
  * [lookup​_regex](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_regex/)
  * [lookup​_startswith](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_startswith/)
  * [parse​_lookup](https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-parse_lookup/)

* libtmux.\_internal.sparse_array 4

  * [Sparse​Array](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-sparsearray/)
  * [Hook​Array](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-hookarray/)
  * [T](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-t/)
  * [is​_sparse​_array​_list](https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-is_sparse_array_list/)

* libtmux.\_internal.types 1

  * [Str​Path](https://libtmux.org/en/py/stable/reference/libtmux-_internal-types-strpath/)

* tmuxp.cli.convert 4

  * [Convert​Unknown​File​Type](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-convert-convertunknownfiletype/)
  * [CONVERT​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-convert-convert_description/)
  * [command​_convert](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-convert-command_convert/)
  * [create​_convert​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-convert-create_convert_subparser/)

* tmuxp.cli.debug_info 5

  * [CLIDebug​Info​Namespace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-debug_info-clidebuginfonamespace/)
  * [DEBUG​_INFO​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-debug_info-debug_info_description/)
  * [tmuxp​_path](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-debug_info-tmuxp_path/)
  * [command​_debug​_info](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-debug_info-command_debug_info/)
  * [create​_debug​_info​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-debug_info-create_debug_info_subparser/)

* tmuxp.cli.edit 3

  * [EDIT​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-edit-edit_description/)
  * [command​_edit](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-edit-command_edit/)
  * [create​_edit​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-edit-create_edit_subparser/)

* tmuxp.cli.freeze 4

  * [CLIFreeze​Namespace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-freeze-clifreezenamespace/)
  * [FREEZE​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-freeze-freeze_description/)
  * [command​_freeze](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-freeze-command_freeze/)
  * [create​_freeze​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-freeze-create_freeze_subparser/)

* tmuxp.cli.import_config 9

  * [Import​Config​Fn](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-importconfigfn/)
  * [IMPORT​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-import_description/)
  * [command​_import](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-command_import/)
  * [command​_import​_teamocil](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-command_import_teamocil/)
  * [command​_import​_tmuxinator](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-command_import_tmuxinator/)
  * [create​_import​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-create_import_subparser/)
  * [get​_teamocil​_dir](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-get_teamocil_dir/)
  * [get​_tmuxinator​_dir](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-get_tmuxinator_dir/)
  * [import​_config](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-import_config-import_config/)

* tmuxp.cli.load 6

  * [CLILoad​Namespace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-load-cliloadnamespace/)
  * [LOAD​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-load-load_description/)
  * [command​_load](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-load-command_load/)
  * [create​_load​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-load-create_load_subparser/)
  * [load​_plugins](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-load-load_plugins/)
  * [load​_workspace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-load-load_workspace/)

* tmuxp.cli.ls 5

  * [CLILs​Namespace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-ls-clilsnamespace/)
  * [Workspace​Info](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-ls-workspaceinfo/)
  * [LS​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-ls-ls_description/)
  * [command​_ls](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-ls-command_ls/)
  * [create​_ls​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-ls-create_ls_subparser/)

* tmuxp.cli.search 19

  * [CLISearch​Namespace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-clisearchnamespace/)
  * [Search​Pattern](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-searchpattern/)
  * [Search​Token](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-searchtoken/)
  * [Workspace​Fields](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-workspacefields/)
  * [Workspace​Search​Result](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-workspacesearchresult/)
  * [Invalid​Field​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-invalidfielderror/)
  * [DEFAULT​_FIELDS](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-default_fields/)
  * [FIELD​_ALIASES](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-field_aliases/)
  * [SEARCH​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-search_description/)
  * [VALID​_FIELDS](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-valid_fields/)
  * [command​_search](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-command_search/)
  * [compile​_search​_patterns](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-compile_search_patterns/)
  * [create​_search​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-create_search_subparser/)
  * [evaluate​_match](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-evaluate_match/)
  * [extract​_workspace​_fields](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-extract_workspace_fields/)
  * [find​_search​_matches](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-find_search_matches/)
  * [highlight​_matches](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-highlight_matches/)
  * [normalize​_fields](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-normalize_fields/)
  * [parse​_query​_terms](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-search-parse_query_terms/)

* tmuxp.cli.shell 4

  * [CLIShell​Namespace](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-shell-clishellnamespace/)
  * [SHELL​_DESCRIPTION](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-shell-shell_description/)
  * [command​_shell](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-shell-command_shell/)
  * [create​_shell​_subparser](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-shell-create_shell_subparser/)

* tmuxp.cli.utils 4

  * [prompt](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-utils-prompt/)
  * [prompt​_bool](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-utils-prompt_bool/)
  * [prompt​_choices](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-utils-prompt_choices/)
  * [prompt​_yes​_no](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-utils-prompt_yes_no/)

* tmuxp.workspace.builder 10

  * [Classic​Workspace​Builder](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-classicworkspacebuilder/)
  * [Workspace​Builder​Protocol](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-workspacebuilderprotocol/)
  * [WORKSPACE​_BUILDERS​_GROUP](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-workspace_builders_group/)
  * [Workspace​Builder](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-workspacebuilder/)
  * [available​_builders](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-available_builders/)
  * [get​_default​_columns](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-get_default_columns/)
  * [get​_default​_rows](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-get_default_rows/)
  * [prepended​_sys​_path](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-prepended_sys_path/)
  * [resolve​_builder​_class](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-resolve_builder_class/)
  * [resolve​_builder​_paths](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-resolve_builder_paths/)

* tmuxp.workspace.constants 1

  * [VALID​_WORKSPACE​_DIR​_FILE​_EXTENSIONS](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-constants-valid_workspace_dir_file_extensions/)

* tmuxp.workspace.finders 9

  * [LOCAL​_WORKSPACE​_FILES](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-local_workspace_files/)
  * [find​_local​_workspace​_files](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-find_local_workspace_files/)
  * [find​_workspace​_file](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-find_workspace_file/)
  * [get​_workspace​_dir](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-get_workspace_dir/)
  * [get​_workspace​_dir​_candidates](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-get_workspace_dir_candidates/)
  * [in​_cwd](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-in_cwd/)
  * [in​_dir](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-in_dir/)
  * [is​_pure​_name](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-is_pure_name/)
  * [is​_workspace​_file](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-finders-is_workspace_file/)

* tmuxp.workspace.freezer 2

  * [freeze](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-freezer-freeze/)
  * [inline](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-freezer-inline/)

* tmuxp.workspace.importers 2

  * [import​_teamocil](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-importers-import_teamocil/)
  * [import​_tmuxinator](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-importers-import_tmuxinator/)

* tmuxp.workspace.loader 4

  * [expand](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-loader-expand/)
  * [expand​_cmd](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-loader-expand_cmd/)
  * [expandshell](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-loader-expandshell/)
  * [trickle](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-loader-trickle/)

* tmuxp.workspace.options 4

  * [Pane​Readiness](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-options-panereadiness/)
  * [Workspace​Builder​Options](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-options-workspacebuilderoptions/)
  * [resolve​_session​_shell](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-options-resolve_session_shell/)
  * [shell​_is​_zsh](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-options-shell_is_zsh/)

* tmuxp.workspace.validation 6

  * [Invalid​Plugins​Validation​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-validation-invalidpluginsvalidationerror/)
  * [Session​Name​Missing​Validation​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-validation-sessionnamemissingvalidationerror/)
  * [Window​List​Missing​Validation​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-validation-windowlistmissingvalidationerror/)
  * [Window​Name​Missing​Validation​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-validation-windownamemissingvalidationerror/)
  * [Schema​Validation​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-validation-schemavalidationerror/)
  * [validate​_schema](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-validation-validate_schema/)

* libtmux_mcp.tools.pane_tools.capture_since 2

  * [CAPTURE​_SINCE​_DEFAULT​_MAX​_BYTES](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-capture_since-capture_since_default_max_bytes/)
  * [CAPTURE​_SINCE​_DEFAULT​_MAX​_LINES](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-capture_since-capture_since_default_max_lines/)

* libtmux_mcp.tools.pane_tools.io 1

  * [CAPTURE​_DEFAULT​_MAX​_LINES](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-io-capture_default_max_lines/)

* libtmux_mcp.tools.pane_tools.lifecycle 1

  * [Pane​Corner](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-lifecycle-panecorner/)

* libtmux_mcp.tools.pane_tools.search 4

  * [SEARCH​_DEFAULT​_LIMIT](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-search-search_default_limit/)
  * [SEARCH​_DEFAULT​_MAX​_LINES​_PER​_PANE](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-search-search_default_max_lines_per_pane/)
  * [SEARCH​_MATCH​_MAX​_SECONDS](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-search-search_match_max_seconds/)
  * [SEARCH​_MAX​_PATTERN​_LENGTH](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-search-search_max_pattern_length/)

* libtmux_mcp.tools.pane_tools.state 2

  * [HISTORY​_LIMIT​_FORMAT](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-state-history_limit_format/)
  * [PANE​_STATE​_FORMAT](https://libtmux.org/en/py/stable/mcp/reference/libtmux_mcp-tools-pane_tools-state-pane_state_format/)

* tmuxp.workspace.builder.classic 2

  * [COLUMNS​_FALLBACK](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-classic-columns_fallback/)
  * [ROWS​_FALLBACK](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-builder-classic-rows_fallback/)

* Types 7

  * [\_Default​Option​Scope](https://libtmux.org/en/py/stable/reference/libtmux-constants-_defaultoptionscope/)
  * [\_Tmux​Version​Unavailable](https://libtmux.org/en/py/stable/reference/libtmux-common-_tmuxversionunavailable/)
  * [Schema​Validation​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-workspace-validation-schemavalidationerror/)
  * [Tmuxp​Exception](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-tmuxpexception/)
  * [Tmuxp​Plugin​Exception](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-tmuxppluginexception/)
  * [Workspace​Builder​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-workspacebuildererror/)
  * [Workspace​Error](https://libtmux.org/en/py/stable/workspace/reference/tmuxp-exc-workspaceerror/)
