Ruby API

method libtmux-ruby v0.1.0.alpha.3

Pane.send_text

Behavior: Pane input and capture.

Source and package

Qualified name: LibTmux::Pane#send_text
Module: LibTmux
Declared in: Pane
Package: libtmux
Source: gems/libtmux/lib/libtmux/entity.rb

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

Description#

Behavior contract: Pane input and capture.

Examples#

Send a command to a shell, poll the pane until its output line appears, then capture it. Match a whole output line so the echoed command cannot satisfy the check. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a 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 d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

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

begin
  # docs:begin main
  require "libtmux"

  LibTmux::Server.start do |server|
    created = server.new_session(
      name: "capture", command: ["/bin/sh"],
      environment: {"ENV" => "/dev/null"}, receipt: true
    )
    pane = created.pane
    pane.send_text("printf '\\nlibtmux capture ready\\n'")
    pane.send_keys("Enter")
    deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 5
    captured = pane.capture.stdout.lines(chomp: true)
    until captured.include?("libtmux capture ready")
      raise "Output did not arrive within five seconds" if Process.clock_gettime(Process::CLOCK_MONOTONIC) > deadline
      sleep 0.05
      captured = pane.capture.stdout.lines(chomp: true)
    end
    raise "Expected output is absent from the pane" unless captured.include?("libtmux capture ready")
    puts "libtmux capture ready"
  end
  # docs:end main
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

Parameters

arg1 (::String) #
timeout (::Numeric) #
cancel (untyped) #

Raises

ArgumentError

Discussed in Server bindings

Scripting & web

Compiled & native

JVM

.NET

tmux

Pane.send_text

Description#

Examples#

Description#

Examples#

Related types#