TypeScript API

server.Server.runShell

TypeScript

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

Module: server
Declared in: Server
Package: libtmux
Source: packages/libtmux/src/server.ts
Other languages: Python Ruby Lua Rust Go Java .NET C++ Swift

runShell ( command : : string , options : : RunShellOptions ) → Promise<readonly string[]> method [source] ¶ method [source] ¶ runShell

Run a shell command through tmux and return whatever it printed.

signal and timeoutMs bound this call's own wait; the tmux server owns and runs run-shell itself, decoupled from this client, so neither one stops the command - only this call's own promise settling early.

In other ports Run a shell command through tmux

Python libtmux.Server.run_shell
Ruby LibTmux::Server#run
Lua No source-verified Lua equivalent is recorded for this operation.
Rust server.Server.run_shell
Go tmux.Server.RunShell
Java io.github.libtmux.Server.Server.runShell
.NET LibTmux.Server.RunShellAsync
C++ libtmux::Server::run_shell
Swift Server.run(_:in:) types a command into a pane rather than running it on the host

Examples

TypeScript Python

const lines = await server.runShell("echo hello");
lines[0]; // "hello"

>>> result = server.run_shell('true')
>>> isinstance(result, list)
True

0 declared, 0 inherited