OCaml

Choose a port 22

Scripting & web

Python

LuaNo matching page

Compiled & native

HaskellNo matching page

JVM

Java

KotlinNo matching page

ScalaNo matching page

ClojureNo matching page

.NET

F#No matching page

PowerShell

BEAM

ErlangNo matching page

ElixirNo matching page

tmux

tmux CLI

GitHub

Packages

Packages and source 6

libtmuxopam package · lib libtmux-unixopam package · unix libtmux-eioopam package · eio libtmux-jsonopam package · json libtmux-workspaceopam package · workspace libtmux-workspace-cliopam package · cli

OCaml · libtmux/libtmux-ocaml

Auto Light Dark

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.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Workspace Manager: API Reference

Up Root

`Libtmux_eio.Workspace.await`

val await : ?compensate_on_failure:bool -> t -> (Libtmux_workspace.Execution.receipt, Libtmux.Error.t) result function libtmux-eio [source] ¶

Public owner: Libtmux_eio

Apply steps at most once per execution handle. Expected failures return a retained journal. On initial application, compensate_on_failure defaults to true, attempting removal of proven newly created panes after failure or cancellation. Passing false skips that compensation. Eio cancellation propagates after progress is recorded and at most 500 ms of protected compensation. Admitted commands can still complete under client ownership; use inspect before manual recovery.

Parameters

compensate_on_failure? (bool) #
arg1 (t) #

In other ports#

Build a session from a workspace description

Equivalents of Build a session from a workspace description in other languages
Language	Equivalent
Python	`tmuxp.workspace.builder.ClassicWorkspaceBuilder.build`
Ruby	`LibTmux::Workspace::Plan#apply`
PowerShell	`LibTmux.Workspace\Invoke-TmuxWorkspace` Applies the exact reviewed `-Plan` after PowerShell confirmation. `-WhatIf` previews without applying it; application is detached.
Julia	`LibTmuxWorkspace.apply` Applies a prepared `WorkspacePlan` on an explicit `Server`, detached and under one deadline. Existing session names fail unless reuse is explicit.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp	`libtmux.workspace:apply-workspace`
TypeScript	`builder.applyWorkspace`
Rust	`src.WorkspaceBuilder.build`
Go	`workspace.Build`
Java	`io.github.libtmux.workspace.WorkspaceBuilder.build`
C#	`LibTmux.Workspace.WorkspaceBuilder.BuildAsync`
C++	`libtmux::workspace::build`
Swift	`WorkspaceBuilder.build(_:on:)`
Perl	`LibTmux::Workspace::load` Loads through installed public core APIs; existing-target policy and known owned rollback effects are explicit.

No equivalent is recorded in Lua, Erlang, Elixir, Clojure, Kotlin, Scala or F#.

Reference preview