Workspace Manager1.xAPI 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

tmuxp 1.74.0 · Source

These pages document tmuxp 1.74.0 at the source revision linked below. Install tmuxp in its own Python environment and let its dependency resolver select a compatible libtmux release. The walkthroughs use Python 3.10 or newer and tmux 3.2a or newer; see tmux support.

Configuration and extensions

Read configuration for normalization, inheritance, directories, commands and hooks. Parsing YAML alone does not establish that a field changes builder behavior. Plugins and custom builders execute Python code from their installed packages or configured import paths.

The inspection shell runs in the same Python environment. Optional interactive backends need their corresponding packages installed.

Output and errors

Machine formats are command-specific. Read output and exit codes for empty output and status exceptions before using tmuxp in automation.

Capture reads current tmux state; it cannot recover original scripts, application state or comments. Review captured commands and directories before reloading. Gallery examples may require their named applications or plugins.

Use builder internals for programmatic construction and extension development.

Command source.

Esc

Type to search.

Reference previewOpen reference