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

.NET workspace internals

Edit this page on GitHub

LibTmux.Workspace 0.0.0-alpha.14 · Source

These pages document the in-development workspace builder for contributors and applications that call its APIs. For workspace loading from a terminal, see tmuxp.

Builder pipelineLink to section

WorkspaceFile.Parse validates the YAML. WorkspaceBuilder.BuildAsync creates the session through a supplied core Server and returns its materialized objects. The caller supplies file reading, cancellation, command-line handling, attachment, and server lifetime.

Read the implementationLink to section

  • 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 scopeLink to section

LibTmux.Workspace reads a tmuxp-style YAML file and builds its session through LibTmux. It returns the session, materialized windows, and any layouts that tmux rejected while leaving their windows usable.

Use it from a launcher or another .NET application that already controls a tmux server. The package adds YAML parsing separately from the core client.

Package and runtimeLink to section

The package targets .NET 8 and .NET 10 and uses YamlDotNet. tmux must run on the host. Pin the prerelease selected by your package manager because public contracts can change between alpha versions.

The accepted format is a closed subset. Unknown keys, Python plugins, configuration search paths, and tmuxp hooks are not silently accepted.

Package documentation

Esc

Type to search.