PowerShell API

cmdlet libtmux-powershell latest

LibTmux.Get-TmuxPaneContent

Capture rendered text from a pane.

Source and package

Qualified name: LibTmux\Get-TmuxPaneContent
Declared in: LibTmux
Package: LibTmux
Source: src/LibTmux.PowerShell/GetTmuxPaneContentCommand.cs

History: Get-TmuxPaneContent [-Pane] <LibTmux.Pane> [-EndLine <System.Nullable[System.Int32]>] -History [-Raw] [-EscapeSequences] [-EscapeNonPrintable] [-JoinWrappedLines] [-PreserveTrailingSpaces] [-TrimTrailingSpaces] [-AlternateScreen] [-Quiet] [-ModeScreen] [-Pending] [-Hyperlinks] [-LineNumbers] [-LineFlags] [<CommonParameters>]Range (default): Get-TmuxPaneContent [-Pane] <LibTmux.Pane> [-StartLine <System.Nullable[System.Int32]>] [-EndLine <System.Nullable[System.Int32]>] [-Raw] [-EscapeSequences] [-EscapeNonPrintable] [-JoinWrappedLines] [-PreserveTrailingSpaces] [-TrimTrailingSpaces] [-AlternateScreen] [-Quiet] [-ModeScreen] [-Pending] [-Hyperlinks] [-LineNumbers] [-LineFlags] [<CommonParameters>] cmdlet LibTmux [source] ¶

Description#

Read a native pane through the core capture request. By default each captured line is a separate string. Raw returns one string joined with LF, without inventing a trailing newline. History starts at the beginning of retained history; StartLine and EndLine select explicit bounds.

Notes

Capture is rendered terminal text, not a byte-exact output stream or proof that a shell command completed. History and StartLine are exclusive. PreserveTrailingSpaces and TrimTrailingSpaces cannot both be selected. Core capability checks govern flags on older tmux versions.

Command details#

Command type: cmdlet
Default parameter set: Range
Positional binding: Enabled.
Pipeline inputs: LibTmux.Pane: Native pipeline type for this command.
Outputs: System.String

Examples#

Example 1 Capture the first pane on the existing server identified by $SocketPath. View source

LibTmux\New-TmuxServer -SocketPath $SocketPath |
    LibTmux\Get-TmuxPane |
    Select-Object -First 1 |
    LibTmux\Get-TmuxPaneContent -Raw

Parameters

-Pane (LibTmux.Pane) #

The pane to capture.

Required
Yes
Position
0
Pipeline input
By value
Validation
ValidateNotNull()
-EndLine (System.Nullable[System.Int32]) #

The last line, relative to the visible pane.

Required
No
Position
Named
Pipeline input
No
-History (System.Management.Automation.SwitchParameter) for History #

Whether capture starts at the oldest retained history.

Required
Yes
Position
Named
Pipeline input
No
Switch
Yes
-Raw (System.Management.Automation.SwitchParameter) #

Whether lines are joined with lf into one rendered string.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-EscapeSequences (System.Management.Automation.SwitchParameter) #

Whether terminal escape sequences are retained.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-EscapeNonPrintable (System.Management.Automation.SwitchParameter) #

Whether nonprintable bytes use octal escapes.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-JoinWrappedLines (System.Management.Automation.SwitchParameter) #

Whether wrapped screen lines are joined.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-PreserveTrailingSpaces (System.Management.Automation.SwitchParameter) #

Whether trailing spaces are retained.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-TrimTrailingSpaces (System.Management.Automation.SwitchParameter) #

Whether trailing spaces are removed.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-AlternateScreen (System.Management.Automation.SwitchParameter) #

Whether the alternate screen is captured.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-Quiet (System.Management.Automation.SwitchParameter) #

Whether a missing alternate screen returns empty content.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-ModeScreen (System.Management.Automation.SwitchParameter) #

Whether the pane's mode screen is captured.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-Pending (System.Management.Automation.SwitchParameter) #

Whether incomplete pending output is captured.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-Hyperlinks (System.Management.Automation.SwitchParameter) #

Whether supported captures include hyperlinks.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-LineNumbers (System.Management.Automation.SwitchParameter) #

Whether supported captures include line numbers.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-LineFlags (System.Management.Automation.SwitchParameter) #

Whether supported captures include line flags.

Required
No
Position
Named
Pipeline input
No
Switch
Yes
-StartLine (System.Nullable[System.Int32]) for Range #

The first line; negative values address scrollback.

Required
No
Position
Named
Pipeline input
No

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

System.String: Native pipeline type for this command.

tmux command#

The tmux commands behind Get-TmuxPaneContent.

capture-pane

tmux C API#

The C declarations in tmux that implement these commands.

cmd_capture_pane_entry cmd_capture_pane_exec

Guides#

Pages that discuss Get-TmuxPaneContent.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

LibTmux.Get-TmuxPaneContent

Description#

Command details#

Examples#

tmux command#

tmux C API#

Guides#