Load a workspace
@libtmux/workspace 0.1.0-alpha.12 · Source
Load a saved configuration into tmux. Use -d for scripts so the command returns
after construction without attaching a terminal. Command delivery does not mean
the programs running in those panes have finished or become ready.
Load without attaching¶
Continue the installation walkthrough with its
workspace.yaml and private socket:
$ tmux-workspace load \ -S "$WORKSPACE_TMP/tmux.sock" \ -f /dev/null \ -d \ --json \ workspace.yaml-S selects the socket path; -L selects a socket name. -f supplies tmux’s
configuration when starting a server. Keep the same endpoint for later capture,
inspection and cleanup. Pass -s another-name to override the final input’s
session name.
Existing sessions and append¶
A session with the requested name is reused. Loading is not a reconciliation operation that removes extra windows. Inspect a failed result before retrying: earlier inputs and changes to a borrowed session can remain.
Inside tmux, --append adds windows to the invoking pane’s session. It needs
valid TMUX and TMUX_PANE values for the selected daemon. Use -d when loading
onto a different server. Multiple inputs are processed in their supplied order.
Attachment and output¶
Human loading can attach a terminal or switch a tmux client. For automation,
choose -d or an authenticated append explicitly; machine output does not
answer interactive questions. --yes accepts supported confirmations.
--json returns a result; --ndjson emits records as work proceeds. Read
output and errors
before consuming those records. --no-progress disables the terminal display;
it does not disable errors. -2 requests 256-color handling from tmux.
Use configuration for fields and hooks for bootstrap scripts and extensions.