Python API

method libtmux latest

Server.from_env

Return the tmux server this process's pane is attached to.

Source and package

Qualified name: libtmux.Server.from_env
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust Go Java C#C++ Swift Kotlin Scala OCaml F# Clojure

from_env ( cls, env: t.Mapping[str, str] | None = None ) → Server method classmethod [source] ¶

Description#

Reads the socket path out of TMUX, which tmux exports into every pane it spawns as "<socket_path>,<server_pid>,<session_id>". Only the socket path is used: the pid and the session id are frozen at pane spawn, and the session id goes stale as soon as the pane's window is moved between sessions. Costs no tmux subprocess -- it is a pure read of the environment.

Examples#

>>> from libtmux.server import Server as TmuxServer  # doctest: +HIDE
>>> socket_path = server.cmd(  # doctest: +HIDE
...     "display-message", "-p", "-t", pane.pane_id, "#{socket_path}"
... ).stdout[0]
>>> env = {  # doctest: +HIDE
...     "TMUX": f"{socket_path},1,0",
...     "TMUX_PANE": pane.pane_id,
... }

>>> TmuxServer.from_env(env)
Server(socket_path=...)

>>> TmuxServer.from_env(env).is_alive()
True

Outside a pane there is no server to name:

>>> try:
...     TmuxServer.from_env({})
... except exc.NotInsideTmux as e:
...     print(e)
Not inside a tmux pane: $TMUX is unset or empty

Parameters

env (t.Mapping[str, str] | None) # – Environment to read. Defaults to os.environ, which is what a process running inside a pane wants; pass an explicit mapping to resolve on behalf of another pane.

Returns

Server Server bound to the socket named by TMUX. Not verified to be alive -- use Server.is_alive() for that.

Raises

NotInsideTmux – When TMUX is unset, empty, or not shaped like tmux's triple.

Guides#

Pages that discuss from_env.

Environment

In other ports#

The server this process is running inside

Equivalents of The server this process is running inside in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no equivalent on `Server`
Rust	`server.Server.from_env`
Go	no equivalent on `Server`
Java	no equivalent on `Server`
C#	`LibTmux.Server.FromEnvironment`
C++	`libtmux::Server::from_env`
Swift	no equivalent on `Server`
OCaml	Endpoint selection is explicit. Construct a named socket or socket path; the library does not infer an ambient server.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.from_env

Description#

Examples#

Guides#

In other ports#

Description#

Examples#

Guides#

In other ports#

Related types#