Python API

libtmux.Server.clients

Python

Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++Swift

clients ( self ) → QueryList[Client] property [source] ¶ property [source] ¶ clients

Clients attached to this tmux server.

Each attached terminal is a separate Client . server.clients returns the typed view; client.client_readonly, client.client_termtype, client.client_session etc. read tmux's client_* format tokens.

Returns an empty QueryList when tmux's list-clients fails for any reason — no running daemon, a missing socket, a permission error, or a subprocess failure. To distinguish "no clients attached" from "tmux unreachable", call Server.is_alive or Server.raise_if_dead .

Returns: QueryList of Client

In other ports List the server's attached clients

Ruby LibTmux::Server#list_clients
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript server.Server.clients
Rust server.Server.clients
Go tmux.Server.Clients
Java io.github.libtmux.Server.Server.clients
.NET LibTmux.Server.Clients
C++ libtmux::Server::clients
Swift Server.clients()

Examples

Python TypeScript

>>> with control_mode() as ctl:
...     names = [c.client_name for c in server.clients]
...     ctl.client_name in names
True

const clients = await server.clients();
clients.map((entry) => entry.tty);

0 declared, 0 inherited