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

github.com/libtmux/libtmux-go/workspace · Source

tmux-workspace is the Go 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 Go 1.26 or newer from the repository root so its workspace modules are selected together. Ordinary loading, capture, discovery, conversion, import and search use native Go services.

Search uses Go regular expressions. --regex-engine python explicitly selects the optional Python regex backend. Plugins, custom builders and shell need tmuxp 1.74.0 in the interpreter selected by TMUX_WORKSPACE_PYTHON.

Extension append refuses a document containing before_script; native scripted append remains supported. Inspect retained effects before retrying extension failures.

The Go workspace library has a separate parser and builder contract. In particular, its accepted fields and variable expansion differ from the CLI.

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