TypeScript SDK VSock reference

See Host sockets for guest connection details, platform support, and security considerations.

VSock routes are local-only and unavailable with the multi-tenant deployment profile.

Typical flow

import { Sandbox } from "microsandbox";

await using sandbox = await Sandbox.builder("worker")
  .image("alpine")
  .vsock("/run/host-api.sock", 5000)
  .create();

SandboxBuilder

vsock()

vsock(hostPath: string, port: number): this

Expose a host Unix stream socket or local Windows named pipe on host CID 2 at port.

vsockDgram()

vsockDgram(hostPath: string, port: number): this

Expose a host Unix datagram socket while preserving datagram boundaries. Datagram routes are unavailable on Windows. Both methods can be called repeatedly to add routes. Host paths must be absolute, and each socket type and port pair must be unique.

⌘I