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

Edit this page on GitHub

LibTmux::Workspace API reference

LibTmux-Workspace 0.001_001 · Source

Use LibTmux::Workspace to validate configuration, inspect a plan, and load sessions, windows, and panes through public core APIs. Planning performs no tmux I/O. Loading reports completed steps, conflicts, and partial failures.

The declarations below preserve native signatures, POD links, and source locations. Read the workspace guide for the versioned JSON format, source installation, and complete CLI examples.

API declarations

Follow a declaration for its signature, members, documentation, and source.

Exports

LibTmux::Workspace::X::Config
Invalid versioned configuration. path identifies the rejected input.
LibTmux::Workspace::X::Conflict
An existing session conflicts with the selected repeat-application policy. No session is created until all names pass the conflict check.
LibTmux::Workspace::X::Load
cause retains the original exception. report records completed steps, the failed step, dispatch uncertainty, and typed cleanup outcomes. Rollback affects only sessions whose creation was proven by returned core handles. See "load" in LibTmux::Workspace and LibTmux::X.
LibTmux::Workspace
Versioned JSON configuration and owned orchestration
LibTmux::Workspace::X
Workspace configuration and partial-load failures
Esc

Type to search.

Reference previewOpen reference