Workspace ManagerconceptInternals

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.

Edit this page on GitHub

Java workspace internals

libtmux-workspace 0.1.2-SNAPSHOT · Source

Build and inspect tmux sessions from application code with the workspace library. To load files from a terminal, start with the native CLI walkthrough.

Builder pipeline

The public WorkspaceBuilder facade reads or parses YAML into immutable configuration records, then builds through a supplied core Server. Parsing and applying use separate package-private helpers. The caller owns command-line handling, attachment, and the server connection.

Read the implementation

  • Guides show builder setup and application code.
  • Topics explain configuration, behavior, and failures.
  • Examples exercise the builder through the language API.
  • API links the configuration and construction interfaces.

Implementation scope

libtmux-workspace builds a new tmux session from a YAML description. It uses libtmux’s Java API and returns the session after capturing the completed window and pane structure.

The module accepts session names, windows, layouts, panes and ordered shell commands. It rejects unknown configuration fields instead of accepting a larger file with missing behavior.

Package and runtime

Use the io.github.libtmux:libtmux-workspace artifact with the libtmux BOM. The module targets Java 21 and requires tmux on the host for building. Parsing YAML does not create a session.

Module documentation

Esc

Type to search.

Reference previewOpen reference