Workspace ManagerInternals

Choose documentation 3

latest

Current version

latest
English

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

Edit this page on GitHub

C# workspace internals

LibTmux.Workspace 0.0.0-alpha.20 · 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

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 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 reads a 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 runtime

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 parser rejects unknown fields. The caller reads the file and selects the server; parsing does not search configuration directories or load extensions.

Package documentation

Esc

Type to search.