Python API

property libtmux stable

Server.clients

Clients attached to this tmux server.

Source and package

Qualified name: libtmux.Server.clients
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: PowerShellcmdlet Juliafunction Ruby Lua TypeScriptRustGoJavaC#C++SwiftKotlinScalaF#function

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

Description#

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 .

Examples#

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

Returns: QueryList of Client

tmux command list-clients

In other ports List the server's attached clients

PowerShell
LibTmux\Get-TmuxClient
Acquires attached clients through -Server and returns shared .NET LibTmux.Client objects.
Julia
LibTmux.clients
clients reads attached clients from a captured Snapshot without contacting tmux.
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.clients
C#
LibTmux.Server.Clients
C++
libtmux::Server::clients
Swift
Server.clients()
Kotlin
io.github.libtmux.kotlin.Server.clients
Scala
io.github.libtmux.scaladsl.Server.clients
F#
LibTmux.FSharp.Server.clients
Builds a deferred client query on the shared .NET LibTmux.Server . Query.list acquires attached clients.

Scripting & web

Compiled & native

JVM

.NET

tmux

Server.clients

Description#

Examples#

Description#

Examples#

Related types#