Ruby API

method libtmux-ruby v0.1.0.alpha.2

Session.list_panes

Module LibTmux

Behavior: Live acquisition.

Source and package

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

def list_panes: ( ?timeout: ::Numeric, ?cancel: untyped ) -> ::Array[::LibTmux::Pane] method libtmux [source] ¶

Description#

Behavior contract: Live acquisition.

Examples#

List panes across the server, within one session, and within one window. 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 list_panes.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|
    work = server.new_session(name: "work", command: ["/bin/cat"], receipt: true)
    work.pane.split(direction: :horizontal, command: ["/bin/cat"])
    server.new_session(name: "other", command: ["/bin/cat"])
    puts "server panes: #{server.list_panes.length}"
    puts "work panes: #{work.entity.list_panes.length}"
    puts "window panes: #{work.window.list_panes.length}"
  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 list_panes.rb

Expected output:

server panes: 3
work panes: 2
window panes: 2

tmux command list-panes

In other ports List a session's panes

PowerShell
LibTmux\Get-TmuxPane
Use the -Session parameter set to acquire panes across that session’s windows.
Julia
Traverse windows(session) and panes(window) in the captured snapshot. panes(snapshot) has server-wide scope.
Python
libtmux.Session.panes
Lua
No source-verified Lua equivalent is recorded for this operation.
TypeScript
session.Session.panes
Rust
session.Session.panes
Go
tmux.Session.Panes
Java
no direct accessor; traverse Session.windows and Window.panes
C#
LibTmux.Session.Panes
C++
libtmux::Session::panes
Swift
Snapshot.panes(of:)
Kotlin
No source-verified Kotlin equivalent is recorded for this operation.
Scala
No source-verified Scala equivalent is recorded for this operation.
F#
LibTmux.FSharp.Session.panes
Builds a deferred pane query from one LibTmux.Session and its server. Query.list acquires panes across that session’s windows.

Scripting & web

Compiled & native

JVM

.NET

tmux

Session.list_panes

Description#

Examples#

Description#

Examples#

Related types#