tmuxp freeze

Export a running tmux session to a workspace configuration file. This allows you to save the current state of your tmux session for later restoration.

Command¶

Freeze a live tmux session to a tmuxp workspace file.

Usage¶

usage: tmuxp freeze [-h] [-S socket-path] [-L socket-name] [-f {yaml,json}]
                    [-o output-path] [--yes] [--quiet] [--force]
                    [session-name]

Examples¶

$ tmuxp freeze mysession -o session.yaml

$ tmuxp freeze -f json mysession

$ tmuxp freeze -y mysession

Positional Arguments¶

session_name session-name¶

Default: None

Options¶

-S socket-path¶

pass-through for tmux -S

Default: None

-L socket-name¶

pass-through for tmux -L

Default: None

-f, --workspace-format¶

format to save in

Default: None
Choices: yaml, json

-o, --save-to output-path¶

file to save to

Default: None
Type: Path

--yes, -y¶

always answer yes

Default: False

--quiet, -q¶

don't prompt for confirmation

Default: False

--force¶

overwrite the workspace file

Default: False

Basic usage¶

Freeze the current session:

Freeze a specific session by name:

$ tmuxp freeze [session_name]

Overwrite an existing workspace file:

$ tmuxp freeze --force [session_name]

Output format¶

Tmuxp will offer to save your session state to .json or .yaml.

If no session is specified, it will default to the attached session.

If the --force argument is passed, it will overwrite any existing workspace file with the same name.