Core LibraryGuides

Choose documentation 2

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Compatibility

This source checkout targets PowerShell 7.4 and .NET 8. The Linux workflow tests the specific PowerShell and tmux versions below; other combinations remain unverified. LibTmux and LibTmux.Workspace are published as prereleases on PowerShell Gallery. Both pin libtmux for .NET. See the install guide for package-manager commands and source builds. Publication does not expand the tested platforms below.

EnvironmentContract
Linux x64The Linux workflow exercises PowerShell 7.4.20 and 7.6.6 with tmux 3.2a and 3.7c. Check the run for the commit you use; a green older commit does not verify newer code.
WSL2Run PowerShell and tmux inside the same Linux environment. The Windows host’s PowerShell process is outside this contract.
macOSIntel and Apple Silicon have an advisory eight-cell trial. Suite failures appear in its job summaries and artifacts without failing the trial check; they do not establish support.
Native Windows and psmuxOutside this port’s scope.

Choose the tmux executable and socket explicitly with New-TmuxServer. A handle alone starts no daemon. The module does not change TMUX or TMUX_PANE in the calling process, and it does not connect to an implicit global server during import or formatting.

Some tmux flags and format expressions vary by version. The typed API checks capabilities where it can; query plans show source pushdown and residual work before execution. A failed or unknown capability check is not an empty result. Capture options identify flags whose availability depends on tmux. Use an explicit raw command for less common tmux operations and inspect its result or error record.

The workspace module is a separate PowerShell package over the shared .NET workspace engine. The MCP server is a separate .NET tool that does not require PowerShell. Its client protocol, toolsets, and task support must be discovered from the installed executable rather than inferred from the PowerShell module version.

See troubleshooting for endpoint, package, input and stream failures.

Esc

Type to search.

Reference preview Open reference