# TypeScript workspace internals

Source: https://libtmux.org/en/ts/latest/workspace/internals/

> Architecture and development interfaces of the TypeScript workspace builder.

**Workspace Manager concept example** A working example of the core library. It can change without notice.

Build and inspect tmux sessions from application code with the workspace
library. To load files from a terminal, start with the
[native CLI walkthrough](https://libtmux.org/en/ts/latest/workspace/guides/installation/).

## Builder pipeline

[`parseWorkspace`](<https://libtmux.org/en/ts/latest/workspace/reference/config-parseworkspace/>) validates input data. [`planWorkspace`](<https://libtmux.org/en/ts/latest/workspace/reference/builder-planworkspace/>) inspects the target
session and reports proposed topology changes; [`applyWorkspace`](<https://libtmux.org/en/ts/latest/workspace/reference/builder-applyworkspace/>) performs the
changes through a caller-owned [`Server`](<https://libtmux.org/en/ts/latest/reference/server-server/>). The caller supplies file reading,
command-line handling, attachment, and application lifetime.

## Read the implementation

- [Guides](https://libtmux.org/en/ts/latest/workspace/internals/guides/) show builder setup and application code.
- [Topics](https://libtmux.org/en/ts/latest/workspace/internals/topics/) explain configuration, behavior, and failures.
- [Examples](https://libtmux.org/en/ts/latest/workspace/internals/examples/) exercise the builder through the language API.
- [API](https://libtmux.org/en/ts/latest/workspace/reference/) links the configuration and construction interfaces.

## Implementation scope

`@libtmux/workspace` applies a declared session layout to a libtmux [`Server`](<https://libtmux.org/en/ts/latest/reference/server-server/>).
Describe windows, panes, working directories, and shell commands as data.
Applying the same description again reuses matching objects.

The package manages tmux structure. It does not supervise processes or restart
commands that have exited. Commands run only in newly created panes by default.

## Package and runtime

Use `@libtmux/workspace` alongside `libtmux`. The published package supports
Node and Bun; its YAML convenience parser requires Bun. You can use validated
JavaScript objects under either runtime. Real tmux control requires tmux on
the host. The package documents Linux as its supported runtime platform.

Read the [configuration and convergence rules](https://libtmux.org/en/ts/latest/workspace/internals/topics/) before applying a
description. The caller supplies input data; the library does not discover
files or load runtime extensions.

[Package documentation](https://github.com/libtmux/libtmux-ts/blob/f85b8de551353f746d50eaf36bf0112f4fe5a528/packages/workspace/README.md)