API

All exports come from the package root:

import { WshClient, generateKeyPair, MSG } from '@johnhenry/wsh';

Client and sessions

Export	What it is
WshClient	Full-lifecycle client: connect, auth, sessions, reverse mode, MCP. WshClient.exec(url, cmd, opts) is the one-shot static.
WshSession	A single PTY or exec channel — write, resize, signal, close, and the onData byte callback.
WshSession’s lifecycle	open · attach · resume · detach · rename. A detached session keeps running host-side.

Transports

Export	What it is
WshTransport	Abstract base — implement it for a custom transport.
WebTransportTransport	Native WebTransport streams.
WebSocketTransport	WebSocket with multiplexed virtual streams — same API as the above.

Pick a transport with the transport option on connect; the session API is identical regardless.

Utilities

Export	What it is
WshKeyStore	Ed25519 key management — IndexedDB storage, OPFS encrypted backup (PBKDF2 + AES-256-GCM).
WshFileTransfer	Upload/download over dedicated streams, 64KB chunks.
WshMcpBridge	Discover and invoke remote MCP tools over the control channel.
SessionRecorder / SessionPlayer	Record and replay PTY I/O with original timing (asciicast v2).
WshVirtualSessionBackend, normalizeSessionData	Building blocks for hosting sessions.
generateKeyPair(extractable)	Create an Ed25519 pair via Web Crypto.
signChallenge()	Build the transcript and sign it for the auth handshake.
fingerprint(publicKey)	SHA-256 hex fingerprint of a public key.

Wire protocol

The protocol is the part most libraries leave implicit; wsh makes it an explicit, code-generated contract. These are the primitives, should you need to speak it directly or debug a frame:

Export	What it is
MSG	80+ message-type constants (hex opcodes) — handshake, channel, gateway, guest sharing, compression, copilot, policy, …
CHANNEL_KIND	pty, exec, meta, file, tcp, udp, job.
AUTH_METHOD	pubkey, password.
cborEncode / cborDecode	The CBOR codec (maps, arrays, strings, ints, bytes, bools, null, floats).
frameEncode / FrameDecoder	4-byte big-endian length-prefixed framing.

The constants in MSG are generated from spec/wsh-v1.yaml in the repo, not hand-maintained — so the documented opcodes and the shipped ones cannot drift.