libtmux_mcp.tools.pane_tools.enter_copy_mode

API reference · Markdown

libtmux_mcp.tools.pane_tools.enter_copy_mode ( pane_id : str | None = None , scroll_up : int | None = None , session_name : str | None = None , session_id : str | None = None , window_id : str | None = None , socket_name : str | None = None ) → PaneInfo

function [source] ¶

function [source] ¶

libtmux_mcp.tools.pane_tools.enter_copy_mode

Enter copy mode in a tmux pane, optionally scrolling up.

Use to navigate scrollback history. After entering copy mode, use snapshot_pane to read the scroll_position and content.

Parameters

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

• scroll_up ( int | None ) – Number of lines to scroll up immediately after entering copy mode.

• 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

PaneInfo Serialized pane info.