Browser Quickstart

This runs Mirage in the browser with an in-memory filesystem and no credentials.

Create the app

This Vite starter needs Node 20.19+ on Node 20, or Node 22.12+:

npm create vite@7 mirage-browser -- --template vanilla-ts
cd mirage-browser
npm install @struktoai/mirage-browser

Replace src/main.ts with:

src/main.ts

import { MountMode, RAMVFS, Workspace } from '@struktoai/mirage-browser'

async function main(): Promise<void> {
  const ws = new Workspace({ '/data': new RAMVFS() }, { mode: MountMode.WRITE })
  await ws.shell('echo "hello mirage" > /data/hello.txt')
  const result = await ws.shell('cat /data/hello.txt')
  document.querySelector<HTMLDivElement>('#app')!.textContent = result.stdoutText
  await ws.close()
}

void main()

Start the development server:

npm run dev

Open the URL Vite prints. The page displays hello mirage. Before choosing a production mount, review the browser limitations and browser support in the VFS table.

Getting Started

Access

AI Agents

VFS

CLIs

Runtimes

Browser Quickstart

Create the app

​Create the app

Create the app