# Runtime and configuration support

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

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

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

`tmux-workspace` is the Rust command for loading and capturing tmux
workspaces. The [installation guide](https://libtmux.org/en/rs/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

Build with the toolchain selected by the repository's [`rust-toolchain.toml`](<https://github.com/libtmux/libtmux-rs/blob/2c165c4433d1bdb747a350bd460364daa4a06a55/rust-toolchain.toml>).
The executable provides native loading, capture, discovery, search, conversion,
import and editing. `--generate` exports its command metadata, manual and
completion scripts.

Plugins, custom builders and [`shell`](<https://libtmux.org/en/rs/latest/workspace/reference/config-paneconfig-shell/>) use an optional tmuxp 1.74 runtime selected
by `TMUX_WORKSPACE_PYTHON`. Scripted and extension loads require supported
child-process observation; targets without it refuse those operations before
changing tmux.

The workspace crate also exposes a library. Its unsupported-field handling and
modeled builder features differ from the CLI; use the library reference for
application code.

## Configuration and failure handling

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

Use [machine output](https://libtmux.org/en/rs/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/rs/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/rs/latest/workspace/internals/) for the programmatic builder.

[CLI source](https://github.com/libtmux/libtmux-rs/blob/e9be0b6f6d22cd2eb79b0ec08964f82e717e5fe4/crates/tmux-workspace/docs/cli.md).