Python API

method libtmux latest

Session.cmd

Execute tmux subcommand within session context.

Source and package

Qualified name: libtmux.Session.cmd
Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/session.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScriptRustGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure

cmd ( self, cmd: str, args: t.Any, target: str | int | None = None, ) → tmux_cmd method [source] ¶

Description#

Automatically binds target by adding -t for object's session ID to the command. Pass target to keyword arguments to override.

Examples#

>>> session.cmd('new-window', '-P').stdout[0]
'libtmux...:....0'

From raw output to an enriched Window object:

>>> Window.from_window_id(window_id=session.cmd(
... 'new-window', '-P', '-F#{window_id}').stdout[0], server=session.server)
Window(@... ...:..., Session($1 libtmux_...))

Parameters

cmd (str) #
args (t.Any) #
target (str | int | None) # – Optional custom target override. By default, the target is the session ID.

Returns

server.cmd

In other ports#

Run a tmux command addressed at a session

Equivalents of Run a tmux command addressed at a session in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.cmd`
Rust	`session.Session.cmd`
Go	`tmux.Session.Cmd`
Java	no equivalent on `Session`
C#	no equivalent on `Session`
C++	no equivalent on `Session`
Swift	no equivalent on `Session`
OCaml	No direct public OCaml equivalent is recorded for this operation.
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

Session.cmd

Description#

Examples#

In other ports#

Description#

Examples#

In other ports#

Related types#