Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux latest

Server.cmd

Execute tmux command respective of socket name and file, return output.

Source and package
Qualified name
libtmux.Server.cmd
Module
libtmux
Declared in
Server
Package
libtmux
Source
src/libtmux/server.py
Other languages
Perlmethod Erlangfunction PowerShell Julia Elixirfunction Haskell Common Lisp RubyLuaTypeScriptRustGoJava C# C++ Swift Kotlin Scala OCaml F# Clojure
cmd ( self, cmd: str, args: t.Any, target: str | int | None = None, ) → tmux_cmd

Examples#

>>> server.cmd('display-message', 'hi')
<libtmux.common.tmux_cmd object at ...>

New session:

>>> server.cmd('new-session', '-d', '-P', '-F#{session_id}').stdout[0]
'$2'
>>> session.cmd('new-window', '-P').stdout[0]
'libtmux...:2.0'

Output of tmux -L ... new-window -P -F#{window_id} to a Window object:

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

Create a pane from a window:

>>> window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0]
'%5'

Output of tmux -L ... split-window -P -F#{pane_id} to a Pane object:

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

common.tmux_cmd

In other ports#

Run a tmux command this port does not model

Equivalents of Run a tmux command this port does not model in other languages
Language Equivalent
Ruby LibTmux::Server#run
Lua libtmux.Server:command
Erlang tmux_server:command/3 Executes an explicit command value with bounded output and separate outcome and cleanup evidence.
Elixir LibTmux.Server.run/3 Runs one trusted Command without attaching a client and returns bounded output with exit evidence.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.cmd
Rust server.Server.cmd
Go tmux.Server.Cmd
Java io.github.libtmux.Server.cmd
C# no equivalent on Server
C++ no equivalent on Server
Swift no equivalent on Server
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl LibTmux::Server::cmd Checked literal argument vector; no shell wrapper or implicit tmux command list.

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

Esc

Type to search.

Reference previewOpen reference