Python workspace manager
Install
Install the workspace package separately from the core library.
$ uv tool install tmuxpInstalls tmuxp in an isolated Python environment. Run tmuxp load ./workspace.yaml.
$ uvx tmuxp --helpRuns without a permanent installation. Replace --help with load ./workspace.yaml to load a workspace.
$ pipx install tmuxpInstalls the tmuxp command in an isolated Python environment.
CLI Manual
Commands, options and machine output.
Configuration
Workspace fields, normalization and execution.
Install and load
Load a workspace on a private socket, then capture it.
Example gallery
Workspace files to start from, with their prerequisites.
Runtime support
Runtime requirements and supported behavior.
Internals
The workspace library, for building sessions from code.
tmuxp loads tmux sessions from YAML or JSON using
libtmux. A file describes windows, panes and commands. tmuxp load builds the
session and can attach to it or leave it detached.
Start here¶
The CLI manual covers discovery, search, editing, conversion and import. Use examples for complete files and their prerequisites.
Install tmuxp separately from the core libtmux package. Its dependency resolver selects a compatible libtmux release. Workspace internals describe the builder and Python extension APIs.