Workspace ManagerconceptAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

libtmux.workspace:plan-workspace

(plan-workspace workspace &optional snapshot)

Public owner: libtmux.workspace

Return 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.

Parameters

Guides#

Pages that discuss plan-workspace.

Esc

Type to search.

Reference previewOpen reference