wterm

A terminal emulator for the web.

wterm (“dub-term”) renders to the DOM — native text selection, copy/paste, find, and accessibility come for free. The core is written in Zig and compiled to WASM for near-native performance.

Packages

Package	Description
@wterm/core	Headless WASM bridge + WebSocket transport
@wterm/dom	DOM renderer, input handler — vanilla JS terminal
@wterm/react	React component + useTerminal hook (TypeScript)
@wterm/just-bash	In-browser Bash shell powered by just-bash
@wterm/markdown	Render Markdown in the terminal

Features

• undefinedZig + WASM core — VT100/VT220/xterm escape sequence parser compiled to a ~12 KB .wasm binary (release build)
• undefinedDOM rendering — native text selection, clipboard, browser find, and screen reader support
• undefinedDirty-row tracking — only touched rows are re-rendered each frame via requestAnimationFrame
• undefinedThemes — CSS custom properties with built-in Default, Solarized Dark, Monokai, and Light themes
• undefinedAlternate screen buffer — vim, less, htop, and similar apps work correctly
• undefinedScrollback history — configurable ring buffer
• undefined24-bit color — full RGB SGR support
• undefinedAuto-resize — ResizeObserver-based terminal resizing
• undefinedWebSocket transport — connect to a PTY backend with binary framing and reconnection

Development

Prerequisites

• Zig 0.15.2+
• Node.js 20+
• pnpm 10+
• portless — npm i -g portless

Setup

pnpm install

Build the WASM binary

zig build

For a release build:

zig build -Doptimize=ReleaseSmall

Build all packages

pnpm build

Run the vanilla demo

Serve the web/ directory with any static file server:

cd web && python3 -m http.server 8000

Run the Next.js example

All dev servers use portless to avoid hardcoded ports. Each app is served at a .localhost URL (e.g. nextjs-example.wterm.localhost).

cp web/wterm.wasm examples/nextjs/public/
pnpm --filter nextjs dev

Run Zig tests

zig build test

License

Apache-2.0