libtmux_mcp.tools.pane_tools.pipe_pane

API reference · Markdown

libtmux_mcp.tools.pane_tools.pipe_pane ( pane_id : str | None = None , output_path : str | None = None , append : bool = True , session_name : str | None = None , session_id : str | None = None , window_id : str | None = None , socket_name : str | None = None ) → str

function [source] ¶

function [source] ¶

libtmux_mcp.tools.pane_tools.pipe_pane

Log a pane's live output to a file (or stop an active log).

Streams everything written to the pane (stdout plus terminal control sequences) into a file on disk — the common use is output_path="/tmp/pane.log" to capture scrollback continuously while the agent watches for errors. When output_path is given, starts logging; when output_path is None, stops any active pipe for the pane.

Parameters

• pane_id ( str | None ) – Pane ID (e.g. '%1').

• output_path ( str | None ) – File path to write output to. None stops piping.

• append ( bool ) – Whether to append to the file. Default True. If False, overwrites.

• session_name ( str | None ) – Session name for pane resolution.

• session_id ( str | None ) – Session ID for pane resolution.

• window_id ( str | None ) – Window ID for pane resolution.

• socket_name ( str | None ) – tmux socket name.

Returns

str Confirmation message.