Install and load a workspace

Edit this page on GitHub

tmuxp 1.74.0 · Source

This page documents the available Python tmuxp reference. Proposed native extensions are labeled separately.

The runnable terminal loader is the separate Python application tmuxp. Its documented prerequisites are Python 3.10 or newer and tmux 3.2 or newer. Install it in an isolated tool environment with uv:

$ uv tool install tmuxp

The tool environment owns tmuxp’s Python dependencies. Installing a native libtmux workspace library does not install a tmuxp-compatible CLI.

Create the inputLink to section

Save this file as workspace.yaml in a writable directory:

session_name: workspace-guide
windows:
  - window_name: editor
    layout: even-horizontal
    panes:
      - echo ready
      - echo second

Load the session detached. Reserve the socket name for this walkthrough:

$ tmuxp load \
    -L workspace-guide \
    -d \
    workspace.yaml

Inspect the two panes:

$ tmux -L workspace-guide list-panes -t '=workspace-guide:editor'

Attach when ready:

$ tmux -L workspace-guide attach-session -t '=workspace-guide'

Detach with your configured tmux detach binding. Before cleanup, optionally try export and reload. Remove only this walkthrough’s session when finished:

$ tmux -L workspace-guide kill-session -t '=workspace-guide'

ContinueLink to section

Discovery explains project files and saved names. Configuration describes accepted fields, and load documents all flags. The compatibility reference records native builder limitations.

tmuxp reference source.