Skip to main content

Quick Install

For Node applications, use Node 22.20+ on Node 22, 24.12+ on Node 24, or 25+. Install the Node package:
It includes the workspace, the shell, and the RAM and Disk VFS: enough for the Quickstart. The packages use ECMAScript modules (ESM). In your application directory, set "type": "module" in package.json before importing them:
npm, pnpm and yarn all work. For FUSE with pnpm, see FUSE setup.

Optional Peer Dependencies

Native and network-heavy libraries are optional peers. Install one only when you use its feature: The FUSE binding also needs pnpm’s onlyBuiltDependencies allow-list and, on macOS, the macFUSE 4+ symlink workaround described in the TypeScript FUSE setup. For a browser application, install @struktoai/mirage-browser instead and follow the browser quickstart.

Install From Source

To contribute to Mirage or run the examples: Building from source needs Rust 1.88 or newer. Install it with rustup.
The examples in examples/typescript/ link to the workspace packages via pnpm’s workspace protocol, so changes in packages/core or packages/node are picked up on the next pnpm build.

Next steps

Quickstart

A workspace, a shell line and its result, in a few lines.

Virtualize data storage

S3, Slack, Google Drive, Postgres and 50+ more, as files.

Mount as a folder

Expose mounts to other programs through FUSE.

Connect an agent

The TypeScript agent SDKs, wired to one workspace.