On this page

libtmux.Session.cmd

Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/session.py

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

Execute tmux subcommand within session context.

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

target ( str | int | None ) – Optional custom target override. By default, the target is the session ID.

Returns

server.cmd

0 declared, 0 inherited