PowerShell API

cmdlet libtmux-powershell latest

LibTmux.Get-TmuxWindow

Read contextual windows from a server or session.

Source and package

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

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

Description#

Accept a native Server or Session as the owner. Each result retains its session placement. A linked window can therefore appear more than once. Id and Name are ordinal literal selectors; they do not expand wildcards.

Notes

Global window identity differs from session-relative placement. Do not silently deduplicate results when placement index matters.

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.
Outputs: LibTmux.Window

Examples#

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

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

Parameters

-Server (LibTmux.Server) for Server #

The server whose windows are read.

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

An ordinal, literal window identifier selector.

Required
No
Position
Named
Pipeline input
No
Completion
ArgumentCompleter("LibTmux.PowerShell.WindowSelectorCompleter")
Validation
ValidateNotNullOrEmpty()
-Name (System.String) #

An ordinal, literal window name selector.

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

The session whose windows 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.Window: Native pipeline type for this command.

tmux command#

The tmux commands behind Get-TmuxWindow.

list-windows -t session scope, cmd_list_windows_exec

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_windows_entry cmd_list_windows_exec

Guides#

Pages that discuss Get-TmuxWindow.

Concepts: Captured state and I/O
Guides: Arrange panes and resize windows
Read tmux objects

In other ports#

A tmux window

Equivalents of A tmux window in other languages
Language	Equivalent
Python	`libtmux.Window`
Ruby	`LibTmux::Window`
Lua	`libtmux.Window`
Julia	`LibTmux.WindowSnapshot` `WindowSnapshot` holds captured physical-window data. `WindowLink` records a placement in a session; actions use `WindowRef`.
Elixir	`LibTmux.Window` `Window` is a physical window. `WindowLink` records its session index and active state.
TypeScript	`window.Window`
Rust	`window.Window`
Go	`tmux.Window`
Java	`io.github.libtmux.Window`
Kotlin	`io.github.libtmux.kotlin.Window`
Scala	`io.github.libtmux.scaladsl.Window`
C#	`LibTmux.Window`
F#	`LibTmux.FSharp.Window` This F# module identifies shared .NET `LibTmux.Window` placements and builds deferred pane queries. `Query.list` acquires their results from tmux.
C++	`libtmux::Window`
Swift	`Window`

List a session's windows

Equivalents of List a session's windows in other languages
Language	Equivalent
Python	`libtmux.Session.windows`
Ruby	`LibTmux::Session#list_windows`
Julia	`LibTmux.windows` `windows` with a captured `SessionSnapshot` reads distinct physical windows in that session. Use `windowlinks` for placements.
TypeScript	`session.Session.windows`
Rust	`session.Session.windows`
Go	`tmux.Session.Windows`
Java	`io.github.libtmux.Session.windows`
Kotlin	`io.github.libtmux.kotlin.Session.windows`
Scala	`io.github.libtmux.scaladsl.Session.windows`
C#	`LibTmux.Session.Windows`
F#	`LibTmux.FSharp.Session.windows` Builds a deferred window query from one `LibTmux.Session` and its server. `Query.list` acquires placements scoped to that session ID.
C++	`libtmux::Session::windows`
Swift	`Snapshot.windows(of:)`

No equivalent is recorded in Lua or Elixir.

List the server's windows

Equivalents of List the server's windows in other languages
Language	Equivalent
Python	`libtmux.Server.windows`
Ruby	`LibTmux::Server#list_windows`
Lua	`libtmux.Snapshot.windows`
Julia	`LibTmux.windows` `windows` with a `Snapshot` reads every captured physical window. Use `windowlinks` for session placements.
Elixir	`LibTmux.Snapshot.windows/1` Returns a `Selection` of every captured physical window. `window_links/1` lists session placements.
TypeScript	`server.Server.windows`
Rust	`server.Server.windows`
Go	`tmux.Server.Windows`
Java	`io.github.libtmux.Server.windows`
Kotlin	`io.github.libtmux.kotlin.Server.windows`
Scala	`io.github.libtmux.scaladsl.Server.windows`
C#	`LibTmux.Server.Windows`
F#	`LibTmux.FSharp.Server.windows` Builds a deferred query for placements across all sessions. `Query.list` acquires the results; a linked window appears once for each session placement.
C++	`libtmux::Server::windows`
Swift	`Server.windows()`

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

LibTmux.Get-TmuxWindow

Description#

Command details#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#