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

Swift workspace internals

TmuxWorkspace 0.1.1 · 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

Workspace holds typed configuration or decodes JSON and optional YAML. WorkspaceBuilder.build applies that description through an async core Server. The caller supplies file reading, server startup, command-line handling, and attachment.

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

TmuxWorkspace builds a tmux session from Swift values or a file configuration. It is a SwiftPM library product beside the core LibTmux product.

Swift and JSON descriptions work without a YAML dependency. Enable the YAMLWorkspaces package trait to add YAML decoding. Building uses the same async core server API under either format.

Existing sessions and versions

The builder refuses an existing session with the requested name. On a later failure, it attempts to remove the exact session it created and reports both errors if cleanup also fails.

These pages describe the current source API. The port distinguishes its unreleased source examples from the released package. Use a matching source revision for these examples, or consult the release’s own README when pinning a published version.

Product and version guidance

Esc

Type to search.

Reference previewOpen reference