Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

API reference · Markdown

workspace.Build ( ctx : context.Context , server : tmux.Server , workspace : Workspace ) → (tmux.Session, error)
function [source]
function [source]
workspace.Build

Build creates the workspace on server and returns the created session.

Build is not atomic. A failure after session creation returns that session; completed mutations remain in tmux. Command failures are not normalized.

Build creates the session and an attached control connection in one process, uses that connection for the build, and closes it before returning. The returned Session is not bound to the closed connection. Build verifies that the session remains reachable after closing it. An attached connection may fire client hooks and policies.

Each pane receives workspace, window, and pane CommandsBefore, then its own Commands. Sleep values pause Build rather than the pane.

Discussed in Build a workspace from a file · Go workspace internals , Go workspace builder examples , Use the Go workspace builder , Go workspace builder behavior , Go workspace builder API

In other ports Build a session from a workspace description
Esc

Type to search.