Runtime and configuration support
workspace consumer 0.1.0 · Source
tmux-workspace is the C++ 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 repository’s cxx-dev CMake preset and its selected compiler.
Native services handle loading, capture, discovery, search, conversion, import
and editing. Search uses C++ ECMAScript regular expressions.
Plugins and custom workspace builders are unsupported. shell is a separate
optional feature that runs tmuxp 1.74.0; select its interpreter with
TMUX_WORKSPACE_PYTHON, or select the executable with TMUX_WORKSPACE_TMUXP.
Use detached loading when no unambiguous controlling terminal or tmux client is available. Append retains its borrowed session and reports changes that remain after a failure.
The workspace library has its own configuration and construction APIs; use their reference for C++ 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.