hub / github.com/Helvesec/rmux
github.com/Helvesec/rmux @v0.8.0
Chat with this repo
18,340 symbols
85,594 edges
1,128 files
951 documented · 5%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
<img src="https://github.com/Helvesec/rmux/raw/v0.8.0/docs/rmux-logo-light.svg" width="238" alt="RMUX logo">
<img src="https://github.com/Helvesec/rmux/raw/v0.8.0/docs/rmux-wordmark-light.svg" width="276" alt="RMUX">
The Universal Multiplexer Engine.
English · Français · 简体中文 · 日本語
[!NOTE] RMUX now has an E2E web multiplexing feature. Learn more in the docs.
RMUX now provides Python and TypeScript SDKs: librmux, @rmux/sdk.
If you have a feature request or want to report anything, please file an issue.
🧭 What is RMUX?
RMUX is an async, typed terminal multiplexer engine written in Rust. It implements 90+ tmux commands and runs natively on Linux, macOS, and Windows with no WSL required.
Use it as a standalone CLI, embed it in Rust terminal apps, or drive it through typed SDKs for Rust, Python, and TypeScript.
✨ Features
- Universal engine: typed SDKs for Rust, Python, and TypeScript.
- Native cross-platform runtime: Linux, macOS, and Windows backends.
- tmux-compatible command surface: 90+ commands covered by focused compatibility tests.
- Engineered and optimized for speed: see Benchmarks.
- Web Share: browser-shared sessions with hybrid post-quantum end-to-end encryption.
- Ratatui widget: render live RMUX panes inside Rust terminal applications.
- Local daemon architecture: shells, panes, windows, sessions, and scrollback stay on your machine.
🚀 Quick Start
rmux list-commands
rmux new-session --help
rmux split-window --help
rmux web-share --help
rmux diagnose --human
Use rmux -V for the installed version.
🎬 Demos
Multi Agents Orchestration
≃ 514 lines |
Agent Broadcast Arena
≃ 2,171 lines |
Mini-Zellij
≃ 944 lines |
Terminal Automation
≃ 1,495 lines |
📦 Installation
| Platform / manager | Command |
|---|---|
/ Homebrew | brew install rmux |
|
/ installer | irm https://rmux.io/install.ps1 \| iex |
|
<img src="docs/install/windows
Extension points exported contracts — how you extend this code
FormatVariables (Interface)A source of values for supported format variables. [20 implementers]
crates/rmux-core/src/formats/context.rs
QueuedCommand (Interface)
(no doc) [11 implementers]
src/cli_args.rs
NonCloneGuard (Interface)
(no doc) [3 implementers]
crates/rmux-sdk/src/error.rs
AttachActionExecutor (Interface)
(no doc) [3 implementers]
crates/rmux-client/src/attach_windows/action.rs
LocaleBackend (Interface)
(no doc) [2 implementers]
src/process_locale.rs
SetOptionTargetResolver (Interface)
(no doc) [2 implementers]
src/cli/config_commands/options.rs
RefreshClientControlScope (Interface)
(no doc) [1 implementers]
crates/rmux-server/src/handler_client/refresh.rs
ScreenWriter (Interface)
(no doc) [2 implementers]
crates/rmux-core/src/input/writer.rs
Core symbols most depended-on inside this repo
expectcalled by 4446
crates/rmux-sdk/src/locator.rs
clone
called by 4022
crates/rmux-server/src/handler.rs
run
called by 1755
tests/common/cli.rs
assert_success
called by 1249
tests/common/cli.rs
expect
called by 1033
crates/rmux-core/src/layout/parser.rs
join
called by 1031
crates/rmux-core/src/box_lines.rs
iter
called by 872
crates/rmux-core/src/session/store.rs
handle
called by 864
crates/rmux-server/src/web/registry.rs
Shape
Languages
Rust99%
Python1%
Modules by API surface
tests/cli_window_surface.rs128 symbols
tests/cli_surface.rs120 symbols
src/cli/claude_launcher.rs97 symbols
crates/rmux-core/src/grid/cell.rs91 symbols
crates/rmux-server/src/web/server_tests.rs88 symbols
scripts/bench/bench_unix.py87 symbols
crates/rmux-server/src/pane_transcript.rs79 symbols
crates/rmux-server/src/pane_io/types.rs79 symbols
crates/rmux-client/src/attach_windows/input.rs76 symbols
crates/rmux-core/src/input/writer.rs73 symbols
crates/rmux-ipc/src/endpoint.rs72 symbols
crates/rmux-core/src/screen/writer.rs72 symbols