# LibTmux::Server#run

- **Module:** LibTmux
- **Package:** libtmux
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/gems/libtmux/lib/libtmux/server.rb#L195
- **Page:** https://libtmux.org/en/ruby/v0.1.1/reference/libtmux-server-run/

```
def run: (
  ::Array[::String],
  ?input: ::String,
  ?timeout: ::Numeric,
  ?cancel: untyped
) -> ::LibTmux::CommandResult
```

Raw tmux arguments retain tmux's separators and format semantics.

Behavior contract: Raw commands.

## Examples

Wake a blocked request from another thread with a cancellation token and read the delivery evidence on the Cancelled error. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with `/bin/cat` and `/bin/sh` available. In an empty directory, save this `Gemfile`:

```ruby
source "https://rubygems.org"

gem "libtmux", "0.1.1"
```

Save this complete program as `cancellation.rb`. Its `Server.start` block owns a private tmux server and stops it on exit, including after an error.

[Source example](https://github.com/libtmux/libtmux-ruby/blob/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/examples/api/cancellation.rb).

```ruby
# frozen_string_literal: true

begin
  # docs:begin main
  require "libtmux"

  LibTmux::Server.start do |server|
    server.new_session(name: "work", command: ["/bin/cat"])
    cancellation = LibTmux::Cancellation.new
    waiting = Thread.new do
      server.run(["wait-for", "-S", "ready", ";", "wait-for", "held"], timeout: 5, cancel: cancellation)
    rescue LibTmux::Cancelled => error
      error
    end
    server.wait_for("ready", timeout: 5)
    cancellation.cancel
    failure = waiting.value
    puts "request: #{failure.class}"
    puts "delivery: #{failure.delivery}"
    cancellation.close
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end
```

Install the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:

```console
$ bundle install && \
  bundle exec ruby cancellation.rb
```

Expected output:

```text
request: LibTmux::Cancelled
delivery: possibly_sent
```

## Parameters

- `arg1` (`::Array[::String]`)
- `input` (`::String`)
- `timeout` (`::Numeric`)
- `cancel` (`untyped`)

## In other ports

Run a shell command through tmux

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Server.run_shell`](/en/py/latest/reference/libtmux-server-run_shell/) (method) |
| TypeScript | [`server.Server.runShell`](/en/ts/latest/reference/server-server-runshell/) (method) |
| Rust | [`server.Server.run_shell`](/en/rs/latest/reference/server-server-run_shell/) (method) |
| Go | [`tmux.Server.RunShell`](/en/go/latest/reference/tmux-server-runshell/) (method) |
| Java | [`io.github.libtmux.Shell.run`](/en/java/latest/reference/io-github-libtmux-shell-shell-run/) (method) |
| C# | [`LibTmux.Server.RunShellAsync`](/en/csharp/latest/reference/libtmux-server-runshellasync/) (method) |
| C++ | [`libtmux::Server::run_shell`](/en/cxx/latest/reference/libtmux-server-run_shell/) (method) |
| 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#.

Run a tmux command this port does not model

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Server.cmd`](/en/py/latest/reference/libtmux-server-cmd/) (method) |
| Lua | [`libtmux.Server:command`](/en/lua/latest/reference/libtmux-server-command/) (method) |
| Elixir | [`LibTmux.Server.run/3`](/en/elixir/latest/reference/libtmux-server-run-3/) (function). Runs one trusted `Command` without attaching a client and returns bounded output with exit evidence. |
| TypeScript | [`server.Server.cmd`](/en/ts/latest/reference/server-server-cmd/) (method) |
| Rust | [`server.Server.cmd`](/en/rs/latest/reference/server-server-cmd/) (method) |
| Go | [`tmux.Server.Cmd`](/en/go/latest/reference/tmux-server-cmd/) (method) |
| Java | [`io.github.libtmux.Server.cmd`](/en/java/latest/reference/io-github-libtmux-server-server-cmd/) (method) |
| C# | no equivalent on `Server` |
| C++ | no equivalent on `Server` |
| Swift | no equivalent on `Server` |

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