Workspace ManagerconceptGuides

Choose documentation 3

v0.1.0.alpha.3

Current version

v0.1.0.alpha.3
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Edit this page on GitHub

Ruby workspace guides

libtmux-workspace 0.1.0.alpha.3 · Source

Validate without tmux

Validation reads and bounds the configuration without starting or contacting a tmux server.

Terminal window
$ libtmux-workspace validate workspace.yaml

Inspect an offline plan

An offline plan lists the ordered creation operations. JSON output includes configured commands and paths, so treat it as application data rather than a redacted diagnostic.

Terminal window
$ libtmux-workspace plan \
--json \
workspace.yaml

Load on an explicit socket

Start an application-owned server, then pass its socket path to load.

Terminal window
$ libtmux-workspace load \
--socket "$TMUX_SOCKET" \
--json \
workspace.yaml

plan --live requires the same selector. --compensate enables guarded cleanup of positively identified created state after failure; it cannot undo shell effects. Attach and client switching are explicit post-apply choices, not defaults.

Source-owned CLI guide

Esc

Type to search.

Reference preview Open reference