LibTmux.Invoke-TmuxHook
LibTmux\Invoke-TmuxHook Run a configured tmux hook now.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/InvokeTmuxHookCommand.cs
- Pane: Invoke-TmuxHook [-Pane] <Lib
Tmux > -Name <System.Pane .String > [-Scope <System.Nullable [LibTmux ]>] [-Global] [-What.Option Scope If ] [-Confirm] [<CommonParameters >] Server (default): Invoke-TmuxHook [-Server] <LibTmux > -Name <System.Server .String > [-Scope <System.Nullable [LibTmux ]>] [-Global] [-What.Option Scope If ] [-Confirm] [<CommonParameters >] Session: Invoke-TmuxHook [-Session] <LibTmux > -Name <System.Session .String > [-Scope <System.Nullable [LibTmux ]>] [-Global] [-What.Option Scope If ] [-Confirm] [<CommonParameters >] Window: Invoke-TmuxHook [-Window] <LibTmux > -Name <System.Window .String > [-Scope <System.Nullable [LibTmux ]>] [-Global] [-What.Option Scope If ] [-Confirm] [<CommonParameters >] -
Description#
Ask tmux to run the selected hook without waiting for its event. The command emits no success output. Completion confirms tmux accepted the request; asynchronous work launched by a hook may still be running. Use an explicit producer signal and
Wait-TmuxChannelwhen application completion matters.WhatIfperforms no I/O.Notes
Serverhooks are the global hook table; tmux has no separate server hook table. Choose a hook supported by the selected scope. Scope and Global pass through to tmux without remapping the owner. Empty pipelines do no I/O. Errors retain the native owner and core exception; Continue permits later owners and Stop terminates. Cancellation cannot undo commands already dispatched. Multiple mutations are sequential, not an atomic replacement.Command details#
- Command type
cmdlet- Default parameter set
-
Server - Confirmation
- Supports
-WhatIfand-Confirm; confirm impact: Medium. - Positional binding
- Enabled.
- Pipeline inputs
-
LibTmux.Server: A native server owner.;LibTmux.Session: A native session owner.;LibTmux.Window: A native window owner.;LibTmux.Pane: A native pane owner. - Outputs
System.Void
Examples#
Example 1 Run a previously configured hook on a native
$session. View sourceTerminal window $session | LibTmux\Invoke-TmuxHook -Name 'alert-bell'- Parameters
-
-
-Pane(LibTmux ) (for.Pane Pane) #The native pane whose table is used.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
The tmux hook name, optionally indexed for a specific entry. tmux expands formats in names.
- Required
- Yes
- Position
- Named
- Pipeline input
- No
- Validation
ValidateNotNullOrEmpty()- Validation
ValidatePattern("\\A[^\\x00]*[^\\s\\x00][^\\x00]*\\z")
-
-Scope(System.Nullable [LibTmux ]) #.Option Scope Override the owner scope with
Server,Session,WindoworPane. Omission uses the native owner scope.- Required
- No
- Position
- Named
- Pipeline input
- No
- Validation
ValidateSet(["Server","Session","Window","Pane"])
-
-Global(System.Management ) #.Automation .Switch Parameter Use the global table for the selected scope. For global session defaults from a
Server, specify ScopeSessionand Global.- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
-
-WhatIf(System.Management ) #.Automation .Switch Parameter Show the selected owner, scope and operation without contacting tmux.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
- Aliases
wi
-
-Confirm(System.Management ) #.Automation .Switch Parameter Ask for confirmation before changing the selected table.
- Required
- No
- Position
- Named
- Pipeline input
- No
- Switch
- Yes
- Aliases
cf
-
-Server(LibTmux ) (for.Server Server) #The native server whose table is used.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-Session(LibTmux ) (for.Session Session) #The native session whose table is used.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-Window(LibTmux ) (for.Window Window) #The native window whose table is used.
- 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 .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
-
None: No success output.