libtmux.workspace:plan-workspace
- (plan-workspace workspace &optional snapshot)
-
Public owner:
libtmux.workspaceReturn a finite local WORKSPACE-PLAN, optionally against captured SNAPSHOT. Without SNAPSHOT, return the deterministic creation plan. With SNAPSHOT, return that plan when the named session is absent, an empty proven no-op when topology matches, or signal WORKSPACE-CONFLICT before dispatch. Planning compares window names, declared indexes, and pane counts; creation-only cwd, argv, and layout are not inferred from mutable live state. Explicit indexes are reserved before automatic windows. Pane creation and final order follow the declaration. No tmux I/O occurs.
Description#
See also:
libtmux.workspace:apply-workspace,libtmux.workspace:plan-steps,libtmux.workspace:workspace-data.
Guides#
Pages that discuss plan-workspace.