PowerShell API

cmdlet libtmux-powershell latest

LibTmux.Get-TmuxSession

Read sessions with optional exact selectors.

Source and package

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

Get-TmuxSession [-Server] <LibTmux.Server> [-Id <System.String>] [-Name <System.String>] [<CommonParameters>] cmdlet LibTmux [source] ¶

Description#

Acquire sessions from a native Server. Id and Name are ordinal, case-sensitive literal selectors; combining them requires both to match. Wildcards are not expanded. An unmatched selector emits nothing; a failed acquisition writes an error.

Notes

Wrap results in @() when a stable array is needed. A missing daemon is an error, not a successful empty list. Session-only capture does not acquire windows.

Command details#

Command type: cmdlet
Positional binding: Enabled.
Pipeline inputs: LibTmux.Server: Native pipeline type for this command.
Outputs: LibTmux.Session

Examples#

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

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

Parameters

-Server (LibTmux.Server) #

The server whose sessions are read.

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

An ordinal, literal session identifier selector.

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

An ordinal, literal session name selector.

Required
No
Position
Named
Pipeline input
No
Completion
ArgumentCompleter("LibTmux.PowerShell.SessionSelectorCompleter")
Validation
ValidateNotNullOrEmpty()

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.Session: Native pipeline type for this command.

tmux command#

The tmux commands behind Get-TmuxSession.

list-sessions

tmux C API#

The C declarations in tmux that implement these commands.

cmd_list_sessions_entry cmd_list_sessions_exec

Guides#

Pages that discuss Get-TmuxSession.

Concepts: Captured state and I/O
Guides: Attaching to tmux
Read tmux objects

In other ports#

A tmux session

Equivalents of A tmux session in other languages
Language	Equivalent
Python	`libtmux.Session`
Ruby	`LibTmux::Session`
Lua	`libtmux.Session`
Julia	`LibTmux.SessionSnapshot` `SessionSnapshot` holds captured session data. Actions use its `SessionRef`, a typed identity bound to an observed daemon generation.
Elixir	`LibTmux.Session` `Session` is an immutable observation. Fields not captured read as `:unloaded`.
TypeScript	`session.Session`
Rust	`session.Session`
Go	`tmux.Session`
Java	`io.github.libtmux.Session`
Kotlin	`io.github.libtmux.kotlin.Session`
Scala	`io.github.libtmux.scaladsl.Session`
C#	`LibTmux.Session`
F#	`LibTmux.FSharp.Session` This F# module builds deferred child queries from a shared .NET `LibTmux.Session` and its server association. `Query.list` acquires their results from tmux.
C++	`libtmux::Session`
Swift	`Session`

List the server’s sessions

Equivalents of List the server’s sessions in other languages
Language	Equivalent
Python	`libtmux.Server.sessions`
Ruby	`LibTmux::Server#list_sessions`
Lua	`libtmux.Snapshot.sessions`
Julia	`LibTmux.sessions` `sessions` reads membership from a captured `Snapshot` without contacting tmux.
Elixir	`LibTmux.Snapshot.sessions/1` Returns a `Selection` of captured sessions without contacting tmux.
TypeScript	`server.Server.sessions`
Rust	`server.Server.sessions`
Go	`tmux.Server.Sessions`
Java	`io.github.libtmux.Server.sessions`
Kotlin	`io.github.libtmux.kotlin.Server.sessions`
Scala	`io.github.libtmux.scaladsl.Server.sessions`
C#	`LibTmux.Server.Sessions`
F#	`LibTmux.FSharp.Server.sessions` Builds a deferred session query on `LibTmux.Server`. `Query.list` acquires the results; it does not traverse the handle’s captured membership.
C++	`libtmux::Server::sessions`
Swift	`Server.sessions()`

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

LibTmux.Get-TmuxSession

Description#

Command details#

Examples#

tmux command#

tmux C API#

Guides#

In other ports#