# Runtime and configuration support

Source: https://libtmux.org/en/ts/latest/workspace/reference/compatibility/

> Runtime requirements and configuration boundaries for the TypeScript workspace command.

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

`tmux-workspace` is the TypeScript command for loading and capturing tmux
workspaces. The [installation guide](https://libtmux.org/en/ts/latest/workspace/guides/installation/) builds the
documented source revision and runs a session on a private socket. The
walkthroughs require tmux 3.3a or newer. A daemon older than 3.3a is refused before any effect; see [tmux support](https://libtmux.org/en/tmux/guides/tmux-support/).

## Runtime and execution

The CLI runs on Node.js 22 or newer and can be built with Bun. Use the
installation guide for the documented revision. Ordinary load, capture,
discovery, search, conversion and import use native services.

Search uses JavaScript regular expressions. Explicit plugins, custom workspace
builders and `shell` use an optional interpreter with tmuxp 1.74.0. Select it
with `TMUX_WORKSPACE_PYTHON`. Empty extension selections keep native execution.

The CLI and `@libtmux/workspace` are separate implementations. The library's
convergence API and strict schema have a different contract from CLI loading.

## Configuration and failure handling

Read [configuration](https://libtmux.org/en/ts/latest/workspace/configuration/) for the CLI's fields. Unsupported
execution fields fail visibly; generic [conversion](https://libtmux.org/en/ts/latest/workspace/cli/convert/)
preserves document values without proving that they can be executed.

Use [machine output](https://libtmux.org/en/ts/latest/workspace/reference/output/) for automation and check both the process
status and any retained effects. Capture reads live tmux state; it cannot
recover original command arguments, scripts, comments or application state.

[Examples](https://libtmux.org/en/ts/latest/workspace/examples/gallery/) provide complete starter documents. Their
pane commands can need additional applications and directories when adapted.
Use [library internals](https://libtmux.org/en/ts/latest/workspace/internals/) for the programmatic builder.

[CLI source](https://github.com/libtmux/libtmux-ts/blob/f36d692552bb9a373b45338bb5fece854e57cc3d/packages/workspace-cli/README.md).