TypeScript Quickstart

Installation

Use a supported Node release, then install the runtime:

pnpm add @struktoai/mirage-node
pnpm add -D tsx typescript

npm install @struktoai/mirage-node and yarn add @struktoai/mirage-node work too.

Create a Workspace

Start with the RAM VFS so you can try Mirage without credentials.

quickstart.ts

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

async function main(): Promise<void> {
  const ws = new Workspace({ '/data': new RAMVFS() }, { mode: MountMode.WRITE })
  await ws.shell(`echo '{"name": "alice"}' > /data/user.json`)

  const files = await ws.shell('ls /data')
  process.stdout.write(files.stdoutText)

  const name = await ws.shell('jq -r ".name" /data/user.json')
  process.stdout.write(name.stdoutText)

  const match = await ws.shell('grep alice /data/user.json')
  process.stdout.write(match.stdoutText)

  await ws.close()
}

main()

Run it; it lists user.json, prints alice, then prints the matching JSON document:

pnpm tsx quickstart.ts

Shell failures are returned in the result; check exitCode and stderrText when needed. See the in-app API reference.

Next Steps

See TypeScript Installation for optional native peers (FUSE, Redis, Postgres, MongoDB, SSH, Email).
Building for the browser? Start with the Browser Quickstart.
Configure command output limits for large files and long-running commands.
Browse TypeScript Agents to wire Mirage into OpenAI Agents SDK, Vercel AI SDK, LangChain, Mastra, and more.
Pick a real backend from the VFS section, such as S3, Slack, or Discord.

Getting Started

Access

AI Agents

VFS

CLIs

Runtimes

TypeScript Quickstart

Installation

Create a Workspace

Next Steps

​Installation

​Create a Workspace

​Next Steps

Installation

Create a Workspace

Next Steps