Core Library0.xAPI Reference

Choose documentation 3

v0.1.1

Current version

v0.1.1
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ruby v0.1.1

Pane.send_keys

Behavior: Pane input and capture.

Source and package
Qualified name
LibTmux::Pane#send_keys
Module
LibTmux
Declared in
Pane
Package
libtmux
Source
gems/libtmux/lib/libtmux/entity.rb
Other languages
PowerShell Julia Elixir PythonLuaTypeScriptRustGo Java C#C++SwiftKotlinScala F#
def send_keys: ( *::String, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CommandResult

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 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:

source "https://rubygems.org"
gem "libtmux", "0.1.1"

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 gem and run the program. An operation or cleanup error makes it exit unsuccessfully:

Terminal window
$ bundle install && \
bundle exec ruby capture.rb

Expected output:

libtmux capture ready
Parameters
Raises
  • ArgumentError

tmux command#

The tmux commands behind send_keys.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Send keystrokes to a pane

Equivalents of Send keystrokes to a pane in other languages
Language Equivalent
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
Kotlin io.github.libtmux.kotlin.Pane.sendKeys
Scala io.github.libtmux.scaladsl.Pane.sendKeys
C# LibTmux.Pane.SendKeysAsync
C++ libtmux::Pane::send_text
Swift Server.sendKeys(_:to:literally:)

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

Esc

Type to search.

Reference previewOpen reference