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.

Workspace Manager: API Reference

Libtmux_workspace

module Libtmux_workspace

Config validates workspace descriptions and Plan previews their actions without I/O. Execution delegates effects to an explicit executor and retains a recovery journal. See the workspace guide for JSON loading, preview, apply and receipt inspection.

Guides#

Pages that discuss Libtmux_workspace.

Members3#

  • Config module Validate native workspace values without contacting tmux or reading the filesystem. Relative directories resolve against the document directory; only declared variables participate in expansion.
  • Execution module Apply a plan once per handle and retain effects, uncertainty and cleanup. The journal lives in process memory while its execution handle is retained; Execution.inspect returns immutable copies. It survives waiter cancellation and client closure, but supplies no crash-durable recovery or cross-invocation deduplication. Ordinary applications use their backend's Workspace module; executors below integrate another transport.
  • Plan module Preview ordered workspace actions against one observed daemon generation. A plan retains collision policy and bound targets; it is not a portable command script.
Esc

Type to search.

Reference previewOpen reference