TypeScript API

method libtmux-ts latest

Server.runShell

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

Source and package

Qualified name: Server.runShell
Module: server
Declared in: Server
Package: libtmux
Source: packages/libtmux/src/server.ts
Other languages: PowerShell Julia Elixir PythonRuby Lua RustGoJavaC#C++ Swift Kotlin Scala F#

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

Description#

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.

Examples#

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

Parameters

command (string) #
options? (RunShellOptions) #

tmux command#

The tmux commands behind runShell.

run-shell

tmux C API#

The C declarations in tmux that implement these commands.

cmd_run_shell_entry cmd_run_shell_exec

In other ports#

Run a shell command through tmux

Equivalents of Run a shell command through tmux in other languages
Language	Equivalent
Python	`libtmux.Server.run_shell`
Ruby	`LibTmux::Server#run`
Rust	`server.Server.run_shell`
Go	`tmux.Server.RunShell`
Java	`io.github.libtmux.Shell.run`
C#	`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

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.runShell

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

In other ports#

Related types#