tmuxp freeze

Edit this page on GitHub

tmuxp 1.74.0 · Source

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

Capture a live session as a starting workspace file. A capture records observable session state; it cannot recover the original scripts, plugin intent, comments, or every application state.

Export a named sessionLink to section

After the installation walkthrough creates workspace-guide, export it to a new destination:

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

Without a session argument, tmuxp resolves or asks for a live session. Without a format or destination, it can ask for those choices. --yes answers yes/no questions; it does not supply every missing selection. --quiet suppresses explanatory status, but prompts can still occur. Successful export writes the workspace document to a file, not stdout. Declining a confirmation can return without saving.

In this reference, an explicit --save-to path bypasses the overwrite confirmation used by the prompted path. Select a new path deliberately. The proposed native contract applies the same protection to explicit and prompted destinations and keeps --force distinct from --yes.

Inspect the capture before reloading. See the export and reload workflow and the proposed machine output for the distinction between a saved file’s format and a CLI result stream.

Arguments and flagsLink to section

All commands accept -h / --help. Root options precede the command; see the CLI overview. The output reference distinguishes current Python flags from proposed all-command JSON and NDJSON.

Parser and implementation source.

tmuxp reference source.