Server.run_shell
Run a shell command on the machine the server is on.
Source and package
- Qualified name
-
libtmux::Server:: run _shell - Namespace
- libtmux
- Declared in
Server- Package
- libtmux-cxx
- Source
- include/libtmux/server.hpp
- Other languages
- Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustGoJavaC# Swift Kotlin Scala OCaml F# Clojure
- [[
C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.]] expected<void, CommandFailure > run_shell(std::string command, bool background = false) const;_view -
Description#
Reports whether it ran, not what it printed. tmux hands back the output on most versions and discards it on 3.3a and 3.4, and an answer that is empty on two versions in the middle of the range is worse than no answer at all. A caller that needs the output redirects it to a file.
What is uniform is the exit status: a command that fails is a failure here, carrying its code in
exit_code.backgroundis tmux's-b, which returns as soon as the command is started. Nothing can then be said about how it ended, so a backgrounded command that fails still reports success.- Parameters
tmux command#
The tmux commands behind run_shell.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Run a shell command through tmux
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | server |
| Rust | server |
| Go | tmux |
| Java | io |
| C# | Lib |
| Swift | Server.run(_:in:) types a command into a pane rather than running it on the host |
| OCaml | No direct public OCaml equivalent is recorded for this operation. |
| Perl | No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands. |
No equivalent is recorded in Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.