server.Server

class server.Server

class [source] ¶

class [source] ¶

class server.Server

One tmux server, addressed by the socket it listens on.

Constructing this starts no process. tmux spawns the daemon on the first command that needs one, and a daemon already listening on that socket is used rather than replaced, so two Server values built from the same options address the same tmux.

Sessions, windows and panes are reached from here and carry the server with them. Handles taken from one daemon do not survive its restart: the replacement numbers panes from %0 again — see DaemonIdentity .

Discussed in TypeScript MCP examples , TypeScript MCP API , TypeScript workspace internals , TypeScript workspace builder examples , TypeScript workspace builder API

In other ports A tmux server

• Python libtmux.Server
• Ruby LibTmux::Server
• Lua libtmux.Server
• Rust server.Server
• Go tmux.Server
• Java io.github.libtmux.Server.Server
• .NET LibTmux.Server
• C++ libtmux::Server
• Swift Server

Members

• sessions method Every session on the server, read now.
• windows method Every window on the server, including each placement of a linked window.
• panes method Every pane on the server.
• clients method Every client attached to the server.
• listBuffers method Every buffer name this server holds.
• listCommands method Every command name the running tmux understands.
• snapshot method Acquire an immutable view of the server at this instant.
• newSession method Create a detached session and resolve it as a handle.
• sourceFile method Run a tmux config file against this server.
• kill method Terminate the tmux server and every session on it.
• showOptions method Every server-scope option tmux currently reports.
• showHooks method Every global hook tmux currently reports.
• setBuffer method Put a string into a named paste buffer.
• isAlive method Whether the tmux server is reachable.
• showEnvironment method Every variable in the server's global environment.
• showBuffer method Read a named paste buffer's contents.
• deleteBuffer method Discard a named paste buffer.
• runShell method Run a shell command through tmux and return whatever it printed.
• setOption method Set a server-scope option.
• setEnvironment method Set a variable in the server's global environment.
• unsetEnvironment method Drop a variable from the server's global environment entirely.
• hasSession method Whether a session with this name exists.
• cmd method Run a tmux command this package does not model.
• unsetOption method Remove a server-scope option.
• loadBuffer method Fill a paste buffer from data fed through tmux's stdin.
• saveBuffer method Write a paste buffer to a file instead of reading it back.
• setHook method Bind a tmux command to a global hook.
• unsetHook method Remove a global hook.
• removeEnvironment method Mark a variable in the server's global environment for removal from the environment of processes tmux starts, leaving the entry in place.
• ifShell method Run one command or another depending on a condition.
• raiseIfDead method Assert the server is reachable, raising with tmux's reason if not.
• version method The tmux version this server is running.
• configFile method The configuration file this server was pointed at, if any.
• socketPath method The socket path this server addresses, if it was given one.
• showGlobalOptions method Read the defaults every session or window inherits.
• setGlobalOption method Set a default every session or window inherits.
• getEnvironment method One variable from the server's global environment, or undefined when tmux carries no entry.
• colors method How many colours this server was told the terminal has.
• socketName method The socket name this server addresses, if it was named rather than pathed.
• batch method Run planned mutations in order, resolving each to what it made.
• connect method Bind this server to one control-mode connection and return it.
• pipeline method Run several tmux commands in order.
• watch method Stream tmux's control-mode notifications until the stream is disposed.
• checkAlive method Assert the server is reachable, raising with tmux's reason if not.
• daemonIdentity method Which daemon is answering on this socket right now.
• equals method Whether other is a handle addressing the same tmux server.
• showBufferBytes method Read a named paste buffer without decoding or splitting its bytes.
• showResolvedOptions method The option values that govern this server, own and inherited together.
• tmuxBin method The tmux executable this server runs.
• unsetGlobalOption method Remove a default, so tmux falls back to its own built-in value.
• versionAtLeast method Whether this server is at least minimum, written the way tmux writes it.
• withConnection method Run body against a connected server, closing it afterwards.
• constructor method
• serverBrand attribute
• toString method How this server renders in a log line or an error.