How pithings/unkernel works
unkernel runs a real Linux kernel compiled to WebAssembly, with a TypeScript host runtime for booting and connecting guest services. The main workflows are starting a guest through the CLI or browser, then interacting with its shell, storage, network, and devices. The browser adds a multi-window terminal UI and persistent-disk experience; the SDK also supports Node, browser workers, and host integrations. Some subsystem links below follow explicit README descriptions or SOURCE INDEX references; unsampled implementation details are not inferred as call sequences.
Main entry points: instance.ts Guest instance · kernel.ts Kernel runtime · worker-serve.ts Worker runtime · worker-host.ts Worker host
Components 27
Kernel host runtime
- Guest instance
js/core/instance.ts - Kernel runtime
js/core/kernel.ts - Kernel loader
js/core/load.ts - Device builder
js/core/devices.ts - Block storage
js/core/block.ts - Guest networking
js/core/net.ts - Host mounts
js/core/mounts.ts - Terminal sessions
js/core/tty.ts - Vsock streams
js/core/vsock.ts - Shared memory
js/core/shm.ts - Snapshots
js/core/snapshot.ts - Framebuffer display
js/core/display.ts - Input devices
js/core/input.ts - Audio output
js/core/sound.ts
Host platforms
- Worker host
js/core/worker-host.ts - Worker runtime
js/core/worker-serve.ts - Worker protocol
js/core/worker-protocol.ts - Shared transport
js/core/worker-shared.ts - Node platform
js/node/platform.ts - Web platform
js/web/worker.ts
Browser experience
- Browser app
web/src/components/App.tsx - Browser boot
web/src/boot.ts - Web SDK entry
web/src/kw.ts - Terminal UI
web/src/ui.ts - Browser state
web/src/store.ts
Ways to launch
- CLI
js/cli.ts
Other components
- User
Connections 30
- User → CLI: runs
- User → Browser app: opens
- CLI → Guest instance: starts guest
js/cli.ts - Browser app → Terminal UI: renders
web/src/components/App.tsx - Browser app → Browser state: reads state
web/src/components/App.tsx - Browser boot → Web SDK entry: boots through
- Web SDK entry → Guest instance: starts guest
- Terminal UI → Browser state: updates
web/src/ui.ts - Guest instance → Kernel loader: loads kernel
js/core/instance.ts - Guest instance → Kernel runtime: creates runtime
js/core/instance.ts - Guest instance → Device builder: builds devices
js/core/instance.ts - Guest instance → Host mounts: configures mounts
js/core/instance.ts - Kernel runtime → Block storage: uses storage
js/core/kernel.ts - Device builder → Block storage: builds disks
js/core/devices.ts - Device builder → Guest networking: builds network
js/core/devices.ts - Guest instance → Terminal sessions: provides sessions
js/core/instance.ts - Guest instance → Vsock streams: provides streams
js/core/instance.ts - Kernel runtime → Shared memory: uses shared memory
js/core/kernel.ts - Kernel runtime → Snapshots: uses snapshots
js/core/kernel.ts - Kernel runtime → Framebuffer display: uses display
js/core/kernel.ts - Kernel runtime → Input devices: uses input
js/core/kernel.ts - Kernel runtime → Audio output: uses sound
js/core/kernel.ts - Worker host → Worker protocol: exchanges messages
js/core/worker-host.ts - Worker runtime → Worker protocol: serves messages
js/core/worker-serve.ts - Worker runtime → Guest instance: creates runtime
js/core/worker-serve.ts - Worker host → Shared transport: uses shared transport
js/core/worker-host.ts - Worker host → Worker runtime: starts worker
- Node platform → Worker runtime: runs worker entry
js/node/worker-entry.ts - Web platform → Worker runtime: runs worker entry
- Guest instance → Worker host: can delegate
js/core/instance.ts