Documentation

Everything you need to get started with wmux, configure keybindings, use the socket API, and integrate with Claude Code.

Getting Started

wmux is a native Windows terminal multiplexer built with Rust and Tauri. It gives you split panes, tabbed workspaces, and a socket API for AI agents — all in a single binary with zero dependencies.

Installation

1. Download the .msi installer from GitHub Releases
2. Run the installer
3. Open wmux from the Start menu

Building from Source

$ cargo install tauri-cli
$ git clone https://github.com/fernandomenuk/wmux.git
$ cd wmux/crates/wmux-app
$ cargo tauri build

Basic Concepts

wmux organizes your terminals using two key concepts:

• Workspaces — Tabs that group related terminal panes together. Think of them like virtual desktops for your terminals. Create a workspace for each project or task.
• Surfaces — Individual terminal panes within a workspace. You can split them vertically or horizontally to view multiple terminals side by side.

When you first launch wmux, you get a single workspace with one surface. From there, you can split panes, create new workspaces, and start building your layout.

Keybindings

wmux uses a prefix key system. Press Ctrl+A first, then press the action key.

Pane Management

Key	Action
Ctrl+A then |	Split vertically
Ctrl+A then -	Split horizontally
Ctrl+A then x	Close current pane
Ctrl+A then z	Zoom (toggle fullscreen pane)

Focus & Navigation

Key	Action
Ctrl+A then ↑	Focus pane above
Ctrl+A then ↓	Focus pane below
Ctrl+A then ←	Focus pane left
Ctrl+A then →	Focus pane right

Workspaces

Key	Action
Ctrl+A then c	Create new workspace
Ctrl+A then n	Next workspace
Ctrl+A then p	Previous workspace
Ctrl+A then 1-9	Switch to workspace by number