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

Edit this page on GitHub

tmuxp 1.74.0 · Source

tmuxp is Python’s workspace manager built on libtmux. A YAML or JSON file describes a session, its windows and panes, and the commands to run. tmuxp load builds that workspace and can attach you to it or leave it detached.

The application also finds saved workspaces, exports a running session, converts configuration formats, and supports Python plugins and custom workspace builders.

Start hereLink to section

  • Guides install tmuxp and load a workspace on a dedicated socket.
  • Topics explain configuration, existing sessions, and exports.
  • Examples load YAML and JSON through the CLI.
  • Internals describe the builder pipeline and Python APIs for contributors and extension authors.

Package and documentationLink to section

Install tmuxp separately from the core libtmux package. Let its dependency resolver choose a compatible libtmux version. The MCP server is another application with its own requirements, so use separate tool environments when their dependency ranges differ.

The tmuxp documentation provides the complete upstream CLI reference, workspace format, and extension documentation.

Upstream quickstart source

tmuxp command and configuration referenceLink to section

The Python command pages document the current tmuxp reference and label proposed native extensions.

Esc

Type to search.