Capture a workspace

@libtmux/workspace 0.1.0-alpha.12 · Source

Capture a running tmux session as a starting point for a workspace file. Capture reads live state. It cannot recover original command arguments, command history, script definitions or plugin intent.

Inspect a session¶

After the installation walkthrough creates workspace-guide, request a machine result from its private socket:

$ tmux-workspace freeze \
    -S "$WORKSPACE_TMP/tmux.sock" \
    --json \
    workspace-guide

Save the captured document¶

Name the destination and format explicitly:

$ tmux-workspace freeze \
    -S "$WORKSPACE_TMP/tmux.sock" \
    --json \
    --workspace-format yaml \
    --save-to captured-workspace.yaml \
    workspace-guide

Use a new destination, or pass --force to authorize replacement. Review captured commands and directories before loading the file on another machine. The saved document encoding is separate from the CLI result format selected by --json or --ndjson.

See export and reload for the complete workflow.

CLI source.