Python

Choose a port 15

Scripting & web

RubyNo matching page

LuaNo matching page

JuliaNo matching page

TypeScriptNo matching page

Compiled & native

RustNo matching page

GoNo matching page

C++No matching page

SwiftNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

tmux

GitHub

Source on GitHub 3

Core Library

libtmuxtmux-python/libtmux

MCP

libtmux-mcptmux-python/libtmux-mcp

Workspace Manager

tmuxptmux-python/tmuxp

Python · tmux-python/libtmux

Packages

Packages on PyPI 3

Core Library

MCP

libtmux-mcpPyPI

Workspace Manager

Python · PyPI

Auto Light Dark

MCPpre-alphaAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references Upstream reference

stable Stable release on its package registry. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

pre-alpha Early development; expect breaking changes. Read more

Workspace Manager Repeatable development environments

Home Guides Topics Examples CLI Manual API Reference Configuration Internals

stable Stable release on its package registry. Read more

stable

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Browse documentation

MCPAPI Reference

`libtmux_mcp.tools.pane_tools.enter_copy_mode`

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] ¶

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

Description#

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.

Reference preview Open reference