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

io.github.libtmux.workspace.WorkspaceBuilder

class io.github.libtmux.workspace.WorkspaceBuilder

Builds a tmux session from a written description.

Description#

Reads the shape of a tmuxp workspace file. Full runtime compatibility with tmuxp is not the aim; starting from a file somebody already has is.

Reading and building are separate. A file that describes something tmux would refuse is rejected while it is still text, before any session exists to leave half-built.

The tmux-workspace command is a separate implementation with a wider document language and its own behaviour around building; see this package's documentation for what differs. Code against this class for what this class does.

Guides#

Pages that discuss WorkspaceBuilder.

Members3#

  • read method Reads a workspace from a file.
  • parse method Reads a workspace from YAML text.
  • build method Creates the described session on a server.
Esc

Type to search.

Reference previewOpen reference