LibTmux.Select-TmuxSession
Filter captured native sessions.
Source and package
- Qualified name
-
LibTmux\ Select-Tmux Session - Declared in
LibTmux- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/SelectTmuxSessionCommand.cs
- Criteria (default): Select-TmuxSession [-Input
Object ] <System.Object []> -Criteria <System.Collections > [-Exactly.IDictionary One ] [<CommonParameters >]Query: Select-TmuxSession [-InputObject ] <System.Object []> -Query <LibTmux > [-Exactly.Query .Query Document One ] [<CommonParameters >] -
Description#
Evaluate criteria against captured native objects using the shared .NET query evaluator. Selection preserves input order, duplicates, object identity and the complete graph behind each object. It does not contact tmux or refresh data. Use
Where-Objectwhen an ordinary PowerShell predicate is sufficient.Ordinary selection streams each match. ExactlyOne retains a match until finite input completes, then emits it only if exactly one input matched. A second match, invalid object, unavailable captured relation, evaluation failure or pipeline stop terminates selection before that retained object is emitted. ExactlyOne counts only the successful objects it receives. An upstream nonterminating error is outside that guarantee. When completeness is required before mutation, use
-ErrorActionStop on every upstream acquisition.Notes
Errors terminate even with
-ErrorActionContinue.Tmux.NoMatchandTmux.MultipleMatchesreport cardinality failures.Tmux.InvalidQueryreports invalid criteria or a mismatched target;Tmux.QuerySelectionFailedretains the native evaluation exception and failing input. ExactlyOne cannot prove cardinality on an input stream that never completes.Command details#
- Command type
cmdlet- Default parameter set
- Criteria
- Positional binding
- Enabled.
- Pipeline inputs
LibTmux.Session: Captured native sessions; no property-name binding.- Outputs
LibTmux.Session
Examples#
Example 1 Capture the existing endpoint selected by
$SocketPath, then select detached sessions. View sourceTerminal window $snapshot = LibTmux\New-TmuxServer -SocketPath $SocketPath |LibTmux\Get-TmuxSnapshot$snapshot.Sessions |LibTmux\Select-TmuxSession -Criteria @{ Attached = $false }- Parameters
-
-
-InputObject(System.Object []) #Native
LibTmux.Sessionobjects, individually or in an array. The callback validates each object and rejects nulls or lookalike objects.- Required
- Yes
- Position
- 0
- Pipeline input
- By value
-
-Criteria(System.Collections ) for.IDictionary Criteria#The criteria map copied before input begins. An empty map accepts every valid native input.
- Required
- Yes
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNull()
-
-ExactlyOne(System.Management ) #.Automation .Switch Parameter Requireexactly one match from successfully completed finite input.- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-Query(LibTmux ) for.Query .Query Document Query#A native query document whose target is
Session.- Required
- Yes
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNull()
Common parameters 12
PowerShell supplies these parameters. See common parameter behavior for their effects.
-
-Verbose(System.Management ) #.Automation .Switch Parameter Display verbose messages produced by this command.
Aliases:vbMicrosoft Learn reference -
-Debug(System.Management ) #.Automation .Switch Parameter Display debug messages produced by this command.
Aliases:dbMicrosoft Learn reference -
-ErrorAction(System.Management ) #.Automation .Action Preference Choose how this command responds to non-terminating errors.
Aliases:eaMicrosoft Learn reference -
-WarningAction(System.Management ) #.Automation .Action Preference Choose how this command responds to warning messages.
Aliases:waMicrosoft Learn reference -
-InformationAction(System.Management ) #.Automation .Action Preference Choose how this command handles information messages.
Aliases:infaMicrosoft Learn reference -
-ProgressAction(System.Management ) #.Automation .Action Preference Choose how this command handles progress updates.
Aliases:progaMicrosoft Learn reference -
-ErrorVariable(System.String ) #Store the command's error records in the named variable.
Aliases:evMicrosoft Learn reference -
-WarningVariable(System.String ) #Store the command's warning records in the named variable.
Aliases:wvMicrosoft Learn reference -
-InformationVariable(System.String ) #Store the command's information records in the named variable.
Aliases:ivMicrosoft Learn reference -
-OutVariable(System.String ) #Save output in the named variable while passing it down the pipeline.
Aliases:ovMicrosoft Learn reference -
Buffer output before passing it to the next pipeline command.
Aliases:obMicrosoft Learn reference -
-PipelineVariable(System.String ) #Make the most recent output object available through a named variable within the pipeline.
Aliases:pvMicrosoft Learn reference
-
- Returns
-
LibTmux.Session: The original matching objects.
Guides#
Pages that discuss Select-TmuxSession.
- Concepts
- Examples