Pane.capture
Behavior: Pane input and capture.
Source and package
- def capture: ( ?start: ::Integer | ::String | nil, ?finish: ::Integer | ::String | nil, ?join: bool, ?escapes: bool, ?escape
_bytes : bool, ?preserve_trailing : bool, ?trim_trailing : bool, ?alternate: bool, ?mode_screen : bool, ?pending: bool, ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux:: Command Result -
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:
Terminal window $ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267Save 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: truebegin# docs:begin mainrequire "libtmux"LibTmux::Server.start do |server|created = server.new_session(name: "capture", command: ["/bin/sh"],environment: {"ENV" => "/dev/null"}, receipt: true)pane = created.panepane.send_text("printf '\\nlibtmux capture ready\\n'")pane.send_keys("Enter")deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 5captured = 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) > deadlinesleep 0.05captured = pane.capture.stdout.lines(chomp: true)endraise "Expected output is absent from the pane" unless captured.include?("libtmux capture ready")puts "libtmux capture ready"end# docs:end mainrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:
Terminal window $ bundle config set --local path vendor/bundle && \bundle install --jobs 2 && \bundle exec ruby capture.rbExpected output:
libtmux capture readytmux command
capture-paneDiscussed in Server bindings · MCP server guide
In other ports Read a pane’s visible contents
- PowerShell No source-verified PowerShell equivalent is recorded for this operation.
- Julia No source-verified Julia equivalent is recorded for this operation.
- Python
- Lua
- TypeScript
- Rust
- Go
- Java
- C#
- C++
- Swift
- Kotlin
- Scala
- F#
- PowerShell