Workspace ManagerconceptAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Workspace Manager: API Reference

src.WorkspaceBuilder.build

Create the session a workspace describes, and return it.

Description#

Windows and panes are created in the order the configuration lists them. Nothing is attached: the caller decides whether to take over a terminal.

Errors

Returns an error when a session of the same name exists, or when tmux refuses any step.

Parameters

Guides#

Pages that discuss build.

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
Go workspace.Build
Java io.github.libtmux.workspace.WorkspaceBuilder.build
C# LibTmux.Workspace.WorkspaceBuilder.BuildAsync
C++ libtmux::workspace::build
Swift WorkspaceBuilder.build(_:on:)
OCaml Libtmux_unix.Workspace.await Apply a validated Plan through submit, then await its retained execution receipt. Inspect preserves partial and late outcomes.
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#.

Esc

Type to search.

Reference previewOpen reference