Python API

libtmux.Pane.cmd

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript
Rust
Go
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift Unavailable

Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/pane.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++ Swift

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

Execute tmux subcommand within pane context.

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

Parameters

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

Returns

server.cmd

In other ports Run a tmux command addressed at a pane

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript pane.Pane.cmd
Rust pane.Pane.cmd
Go tmux.Pane.Cmd
Java no equivalent on Pane
.NET no equivalent on Pane
C++ no equivalent on Pane
Swift no equivalent on Pane

Examples

Python TypeScript Rust

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

From raw output to an enriched Pane object:

>>> Pane.from_pane_id(pane_id=pane.cmd(
... 'split-window', '-P', '-F#{pane_id}').stdout[0], server=pane.server)
Pane(%... Window(@... ...:..., Session($1 libtmux_...)))

await pane.cmd("clock-mode");

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("raw").await?;
let window = session.active_window().await?.expect("a window");
let pane = window.active_pane().await?.expect("a pane");

let result = pane
    .cmd(libtmux::Command::new("display-message").arg("-p").arg("#{pane_id}"))
    .await?;
assert_eq!(result.stdout_lossy().trim(), pane.id().to_string());

guard.shutdown().await?;

0 declared, 0 inherited