Workspace ManagerconceptAPI Reference

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.

Workspace Manager: API Reference

Edit this page on GitHub

Runtime and configuration support

tmux-workspace 0.1.2 · Source

tmux-workspace is the Rust command for loading and capturing tmux workspaces. The installation guide 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.

Runtime and execution

Build with the toolchain selected by the repository’s 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 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 for the CLI’s fields. Unsupported execution fields fail visibly; generic conversion preserves document values without proving that they can be executed.

Use machine 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 provide complete starter documents. Their pane commands can need additional applications and directories when adapted. Use library internals for the programmatic builder.

CLI source.

Esc

Type to search.

Reference previewOpen reference