libtmux
Reference MCP Search
Colour scheme
Menu
English
Reference MCP

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

Python documentation

libtmux.Client

Python
  • Python
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

Module
libtmux
Package
libtmux
Source
src/libtmux/client.py
class libtmux.Client
class [source]
class [source]
class libtmux.Client
Bases:

tmux(1) Client [client_manual].

A tmux client is an attached terminal. The same tmux server can have multiple clients attached simultaneously (e.g. $ tmux attach from several terminals) and each receives its own view of the active session, window, and pane.

Examples

>>> with control_mode() as ctl:
...     attached = [
...         c
...         for c in server.clients
...         if c.client_name == ctl.client_name
...     ]
>>> bool(attached)
True
>>> with control_mode() as ctl:
...     client = server.clients.get(client_name=ctl.client_name)
...     client.client_readonly in {"0", "1"}
True

References

[client_manual]

tmux client. openbsd manpage for TMUX(1). "tmux supports multiple attached clients. Each client has its own keymap, view of the session, and message log." https://man.openbsd.org/tmux.1#DESCRIPTION. Accessed 2026.

7 declared, 179 inherited

Members

Inherited members

Reached through libtmux.neo.Obj.

Esc

Type to search.