tmuxp load

Edit this page on GitHub

TmuxWorkspace 0.1.0-alpha.5 · Source

tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.

The local Swift tmux-workspace load attaches from a foreground terminal and offers switch, detached, append or cancel choices inside tmux. -y skips the mode prompt but refuses an ambiguous client selection. Redirected and machine calls require -d or --append. Inputs are validated before prompting, and detaching or interrupting the client preserves the loaded workspaces.

Clients using independent active-pane focus on the invoking pane’s physical window prevent native switching. The n (detached) and a (append) choices remain available; such clients on other windows do not block switching. If the selected client gains active-pane before handoff, switching fails and the loaded workspace is preserved.

Load a workspace file, saved workspace name, or project directory. Multiple inputs build in order; without -d, the final session is attached or selected through the current-client flow.

Loading and attachmentLink to section

Create workspace.yaml using the installation walkthrough, then load it on that walkthrough’s dedicated socket:

$ tmuxp load \
    -S "$WORKSPACE_TMP/tmux.sock" \
    -d \
    "$WORKSPACE_TMP/workspace.yaml"

-d avoids attachment. Inside an existing tmux client, the normal interactive flow can switch to the new session, append windows, or stay detached. --append explicitly selects the append flow and needs a current target session. An existing session is handled through tmuxp’s load policy; loading is not a declarative reconciliation operation that removes surplus windows.

Put flags before the complete group of filenames. The reference accepts flags before or after that group, but a flag between two filenames can cause an argument error. -s overrides the final input’s session name when several files are loaded. tmuxp parses -2 and -8 as mutually exclusive flags, separate from the CLI text’s --color setting. Legacy -8 is unsupported; tmux removed 88-color support.

Progress and script outputLink to section

--progress-format accepts default, minimal, "window", "pane", verbose, or a custom format. Available tokens include {session}, {window}, {window_index}, {window_total}, {window_progress}, {window_progress_rel}, {windows_done}, {windows_remaining}, {pane_index}, {pane_total}, {pane_progress}, {progress}, {session_pane_progress}, {overall_percent}, {bar}, {pane_bar}, {window_bar}, and {status_icon}.

The Python reference panel defaults to three lines. --progress-lines 0 hides the panel and sends script output to stdout; -1 permits all available lines up to terminal height. --no-progress disables animation. See environment settings for environment bindings and command ordering for what is executed.

Native Swift also defaults to three panel lines. Hiding its panel preserves each bootstrap stream’s original destination. The panel updates while the script runs, retains at most 65,536 UTF-8 bytes and uses the initial terminal size without tracking resize events. JSON and NDJSON disable the panel and send live bootstrap chunks as structured stderr warnings. Cancellation clears the panel and attempts bounded final output; see the child output contract.

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 native all-command JSON and NDJSON.

Parser and implementation source.

tmuxp reference source.