PowerShell API

cmdlet libtmux-powershell latest

LibTmux.Get-TmuxPane

Read panes from a server, session or window.

Source and package

Qualified name: LibTmux\Get-TmuxPane
Declared in: LibTmux
Package: LibTmux
Source: src/LibTmux.PowerShell/GetTmuxPaneCommand.cs
Other languages: Juliastruct Elixirstruct PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF#module

Server (default): Get-TmuxPane [-Server] <LibTmux.Server> [-Id <System.String>] [<CommonParameters>]Session: Get-TmuxPane [-Session] <LibTmux.Session> [-Id <System.String>] [<CommonParameters>]Window: Get-TmuxPane [-Window] <LibTmux.Window> [-Id <System.String>] [<CommonParameters>] cmdlet LibTmux [source] ¶

Description#

Acquire panes from the native owning object. Id is an ordinal literal selector. Linked windows can expose multiple contextual placements of one physical pane. Use native Where-Object over the returned captured properties for local selection.

Notes

CurrentCommand and CurrentPath read captured data without I/O. Zero results emit nothing; one emits one object; many emit separate objects. Use @() for a stable array.

Command details#

Command type: cmdlet
Default parameter set: Server
Positional binding: Enabled.
Pipeline inputs: LibTmux.Server: Native pipeline type for this command.; LibTmux.Session: Native pipeline type for this command.; LibTmux.Window: Native pipeline type for this command.
Outputs: LibTmux.Pane

Examples#

Example 1 List panes on the existing server identified by $SocketPath. View source

LibTmux\New-TmuxServer -SocketPath $SocketPath | LibTmux\Get-TmuxPane

Parameters

-Server (LibTmux.Server) for Server #

The server whose panes are read.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()
-Id (System.String) #

An ordinal, literal pane identifier selector.

Required
No
Position
Named
Pipeline input
No
Completion
ArgumentCompleter("LibTmux.PowerShell.PaneSelectorCompleter")
Validation
ValidateNotNullOrEmpty()
-Session (LibTmux.Session) for Session #

The session whose panes are read.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()
-Window (LibTmux.Window) for Window #

The window whose panes are read.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()

Common parameters 12

PowerShell supplies these parameters. See common parameter behavior for their effects.

-Verbose (System.Management.Automation.SwitchParameter) #

Display verbose messages produced by this command.

Aliases: vb Microsoft Learn reference
-Debug (System.Management.Automation.SwitchParameter) #

Display debug messages produced by this command.

Aliases: db Microsoft Learn reference
-ErrorAction (System.Management.Automation.ActionPreference) #

Choose how this command responds to non-terminating errors.

Aliases: ea Microsoft Learn reference
-WarningAction (System.Management.Automation.ActionPreference) #

Choose how this command responds to warning messages.

Aliases: wa Microsoft Learn reference
-InformationAction (System.Management.Automation.ActionPreference) #

Choose how this command handles information messages.

Aliases: infa Microsoft Learn reference
-ProgressAction (System.Management.Automation.ActionPreference) #

Choose how this command handles progress updates.

Aliases: proga Microsoft Learn reference
-ErrorVariable (System.String) #

Store the command's error records in the named variable.

Aliases: ev Microsoft Learn reference
-WarningVariable (System.String) #

Store the command's warning records in the named variable.

Aliases: wv Microsoft Learn reference
-InformationVariable (System.String) #

Store the command's information records in the named variable.

Aliases: iv Microsoft Learn reference
-OutVariable (System.String) #

Save output in the named variable while passing it down the pipeline.

Aliases: ov Microsoft Learn reference
-OutBuffer (System.Int32) #

Buffer output before passing it to the next pipeline command.

Aliases: ob Microsoft Learn reference
-PipelineVariable (System.String) #

Make the most recent output object available through a named variable within the pipeline.

Aliases: pv Microsoft Learn reference

Returns

LibTmux.Pane: Native pipeline type for this command.

tmux command#

The tmux commands behind Get-TmuxPane.

list-panes -a server scope, cmd_list_panes_server list-panes -s session scope, cmd_list_panes_session list-panes -t window scope, cmd_list_panes_window

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_panes_entry cmd_list_panes_server cmd_list_panes_session cmd_list_panes_window

Guides#

Pages that discuss Get-TmuxPane.

Concepts: Captured state and I/O
Guides: Send input to a pane
Arrange panes and resize windows
Read tmux objects

In other ports#

A tmux pane

Equivalents of A tmux pane in other languages
Language	Equivalent
Python	`libtmux.Pane`
Ruby	`LibTmux::Pane`
Lua	`libtmux.Pane`
Julia	`LibTmux.PaneSnapshot` `PaneSnapshot` holds captured pane data. Actions use its `PaneRef`; `PaneOccurrence` adds a window placement in a session.
Elixir	`LibTmux.Pane` `Pane` is an immutable physical pane observation. It does not send keys or capture text.
TypeScript	`pane.Pane`
Rust	`pane.Pane`
Go	`tmux.Pane`
Java	`io.github.libtmux.Pane`
Kotlin	`io.github.libtmux.kotlin.Pane`
Scala	`io.github.libtmux.scaladsl.Pane`
C#	`LibTmux.Pane`
F#	`LibTmux.FSharp.Pane` This F# module reads captured fields and starts explicit operations on the shared .NET `LibTmux.Pane` type.
C++	`libtmux::Pane`
Swift	`Pane`

List a window's panes

Equivalents of List a window's panes in other languages
Language	Equivalent
Python	`libtmux.Window.panes`
Ruby	`LibTmux::Window#list_panes`
Julia	`LibTmux.panes` `panes` with a captured `WindowSnapshot` reads panes in that window; missing coverage is an error.
TypeScript	`window.Window.panes`
Rust	`window.Window.panes`
Go	`tmux.Window.Panes`
Java	`io.github.libtmux.Window.panes`
Kotlin	`io.github.libtmux.kotlin.Window.panes`
Scala	`io.github.libtmux.scaladsl.Window.panes`
C#	`LibTmux.Window.Panes`
F#	`LibTmux.FSharp.Window.panes` Builds a deferred pane query from one `LibTmux.Window` and its server. `Query.list` acquires panes scoped to that window ID.
C++	`libtmux::Window::panes`
Swift	`Snapshot.panes(of:)`

No equivalent is recorded in Lua or Elixir.

List a session's panes

Equivalents of List a session's panes in other languages
Language	Equivalent
Python	`libtmux.Session.panes`
Ruby	`LibTmux::Session#list_panes`
Julia	Traverse `windows(session)` and `panes(window)` in the captured snapshot. `panes(snapshot)` has server-wide scope.
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`
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.
C++	`libtmux::Session::panes`
Swift	`Snapshot.panes(of:)`

No equivalent is recorded in Lua, Elixir, Kotlin or Scala.

List the server's panes

Equivalents of List the server's panes in other languages
Language	Equivalent
Python	`libtmux.Server.panes`
Ruby	`LibTmux::Server#list_panes`
Lua	`libtmux.Snapshot.panes`
Julia	`LibTmux.panes` `panes` with a `Snapshot` reads every captured physical pane. Use `paneoccurrences` for session placements.
Elixir	`LibTmux.Snapshot.panes/1` Returns a `Selection` of every captured physical pane without contacting tmux.
TypeScript	`server.Server.panes`
Rust	`server.Server.panes`
Go	`tmux.Server.Panes`
Java	`io.github.libtmux.Server.panes`
Kotlin	`io.github.libtmux.kotlin.Server.panes`
Scala	`io.github.libtmux.scaladsl.Server.panes`
C#	`LibTmux.Server.Panes`
F#	`LibTmux.FSharp.Server.panes` Builds a deferred pane query on the shared .NET `LibTmux.Server`. `Query.list` acquires panes across that server.
C++	`libtmux::Server::panes`
Swift	`Server.panes()`

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

LibTmux.Get-TmuxPane

Description#

Command details#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#