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

TmuxWorkspace 0.1.1 · Source

tmux-workspace is the Swift 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

Use Swift 6.2. YAML decoding requires the YAMLWorkspaces build trait; JSON documents work without it. Keep the matching runtime libraries available when running a source-built Linux executable.

Native services handle loading, capture, discovery, search, conversion, import and editing. Search uses ICU regular expressions. Select an explicit endpoint with -S or -L when loading outside tmux.

Set delays on panes. Command mappings support Enter overrides but reject per-command timing fields. Plugins and custom workspace builders are unsupported. The optional tmux-workspace shell command requires tmuxp 1.74.0 in the interpreter selected by TMUX_WORKSPACE_PYTHON.

The TmuxWorkspace library has a separate model and construction API. Consult its reference when building sessions from Swift 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