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

Export and reload a session

Edit this page on GitHub

tmuxp 1.74.0 · Source

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

Use the session created by the installation walkthrough. Capture it to a new YAML destination:

Terminal window
$ tmuxp freeze \
-L workspace-guide \
--workspace-format yaml \
--save-to captured-workspace.yaml \
--yes \
workspace-guide

Review the output file. Capture cannot reconstruct original scripts, shell history, plugin decisions, comments, or every application’s state. Compare window and pane topology, directories, layouts, environment, and options explicitly.

Replay under a new name on the same dedicated server:

Terminal window
$ tmuxp load \
-L workspace-guide \
-d \
-s workspace-replay \
captured-workspace.yaml

Inspect the replay:

Terminal window
$ tmux -L workspace-guide list-panes -t '=workspace-replay'

Remove the replay when finished:

Terminal window
$ tmux -L workspace-guide kill-session -t '=workspace-replay'

The freeze reference explains prompts and overwrite behavior. convert changes document representation without validating native execution support. The native compatibility page records which ports lack capture or lose fields.

tmuxp reference source.

Esc

Type to search.