On this page

server.Server.cmd

Module: server
Declared in: Server
Package: @libtmux/libtmux
Source: packages/libtmux/src/server.ts

cmd ( command : : string , args : : readonly string[] = [] , options : : CmdOptions ) → Promise<readonly string[]> method [source] ¶ method [source] ¶ cmd

Run a tmux command this package does not model.

tmux has many more commands than any wrapper types. Rather than leaving a caller to build their own subprocess — and reproduce the socket, the environment, the deadline, and the error handling — this runs one through the same path every other operation uses.

Failure raises TmuxCommandError like any other command, carrying tmux's own stderr.

Examples

await server.cmd("list-keys", ["-T", "copy-mode"]);

0 declared, 0 inherited