Ruby API

method libtmux-ruby v0.1.0.alpha.2

Pane.send_keys

Module LibTmux

Behavior: Pane input and capture.

Source and package

Module: LibTmux
Declared in: Pane
Package: libtmux
Source: gems/libtmux/lib/libtmux/entity.rb
Other languages: PowerShell Julia Python Lua TypeScript Rust Go Java C#C++Swift Kotlin Scala F#

def send_keys: ( *::String, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult method libtmux [source] ¶

Description#

Behavior contract: Pane input and capture.

Examples#

Send a command to a shell, wait for its output notification, then capture the pane. Match a whole output line so the echoed command cannot satisfy the check. Use Ruby 4.0.7, Bundler, Git and tmux 3.2a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout dcc9f8b5a6970144a9e7d80cd5f381d8f6198372

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux", path: "libtmux-source/gems/libtmux"

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

# frozen_string_literal: true

require "libtmux"

begin
  LibTmux::Server.start do |server|
    created = server.new_session(
      name: "capture", command: ["/bin/sh"],
      environment: {"ENV" => "/dev/null"}, receipt: true
    )
    pane = created.pane
    server.open_control(session: created.entity.ref) do |control|
      control.exchange("display-message -p ready", timeout: 1)
      output = control.subscribe(pane_id: pane.id, max_bytes: 8192, max_events: 32)
      pane.send_text("printf '\\nlibtmux capture ready\\n'")
      pane.send_keys("Enter")
      deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 5
      bytes = "".b
      until bytes.lines(chomp: true).include?("libtmux capture ready")
        remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
        raise "Output did not arrive within five seconds" unless remaining.positive?
        bytes << output.next(timeout: remaining).data
      end
      captured = pane.capture.stdout.lines(chomp: true)
      raise "Expected output is absent from the pane" unless captured.include?("libtmux capture ready")
      puts "libtmux capture ready"
    end
  end
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

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

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby capture.rb

Expected output:

libtmux capture ready

Raises

ArgumentError

tmux command send-keys

In other ports Send keystrokes to a pane

PowerShell
No source-verified PowerShell equivalent is recorded for this operation.
Julia
No source-verified Julia equivalent is recorded for this operation.
Python
libtmux.Pane.send_keys
Lua
libtmux.Pane:send_keys
TypeScript
pane.Pane.sendKeys
Rust
pane.Pane.send_keys
Go
tmux.Pane.SendKeys
Java
no direct equivalent; Pane.paste writes a buffer instead
C#
LibTmux.Pane.SendKeysAsync
C++
libtmux::Pane::send_text
Swift
Server.sendKeys(_:to:literally:)
Kotlin
io.github.libtmux.kotlin.Pane.sendKeys
Scala
io.github.libtmux.scaladsl.Pane.sendKeys
F#
No source-verified F# equivalent is recorded for this operation.

Scripting & web

Compiled & native

JVM

.NET

tmux

Pane.send_keys

Description#

Examples#

Description#

Examples#

Related types#