Workspace ManagerconceptAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Topics Examples CLI Manual API Reference

concept Working example; may change without notice. Read more

v0.1.2

Current version

English

Early release libtmux is released, and its APIs may still change between releases. 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

`LibTmux::Workspace::Plan#apply`

def apply: ( server: ::LibTmux::Server, ?timeout: ::Numeric, ?cancel: untyped, ?compensate: bool ) -> ::LibTmux::Workspace::ApplyResult method libtmux-workspace [source] ¶

Behavior: Workspace apply.

Description#

Behavior contract: Workspace apply.

Parameters

server (::LibTmux::Server) #
timeout (::Numeric) #
cancel (untyped) #
compensate (bool) #

Guides#

Pages that discuss apply.

Workspace guide

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`
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.
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:)`

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

Reference preview