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

Workspace API reference

libtmux/workspace 0.1.0 · Source

Load libtmux/workspace to validate and plan workspace data, then apply it through an explicit client. The libtmux/workspace/cli system provides the command entry point. Both systems use the native core library.

The workspace guide covers configuration, cleanup, conflicts, and partial outcomes. The declarations below come from the same source revision as the guide.

API declarations

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

Exports

libtmux.workspace
Owned Common Lisp workspace descriptions and explicit tmux application. MAKE-WORKSPACE validates inert native data without evaluation. PLAN-WORKSPACE is local and pure; APPLY-WORKSPACE is the explicit external-operation boundary. Workspace objects, plans, steps, results, and their readers return defensive data. Conflicts fail before mutation, and partial application retains evidence.
libtmux.workspace.cli
Command-line adapter for bounded libtmux workspace documents. VALIDATE and PLAN are local. APPLY requires an explicit socket path and uses a scoped libtmux client. Output is one JSON summary; failures return a nonzero status without entering the debugger.
Esc

Type to search.

Reference previewOpen reference