Installation

Prerequisites

Python 3.12 or newer for mirage-ai and its mirage CLI
Node.js 22.20+ on Node 22, 24.12+ on Node 24, or 25+ for @struktoai/mirage-node and @struktoai/mirage-cli
Browser builds can use @struktoai/mirage-browser with Node 20.18.1+ on Node 20, or Node 22+
macOS or Linux (FUSE-based mounts require platform support)

Python

uv add mirage-ai

This installs both the mirage library and the mirage CLI binary. Each agent framework adapter is an extra, such as uv add 'mirage-ai[openai]'. The default runtimes that run python3, node and js inside Mirage are extras too:

uv add 'mirage-ai[monty,quickjs]'

QuickJS also needs a qjs-wasi.wasm module; see QuickJS installation.

TypeScript

Pick the package that matches your runtime — @struktoai/mirage-core is auto-pulled by both Node and browser entrypoints.

npm install @struktoai/mirage-node      # Node.js servers and CLIs
npm install @struktoai/mirage-browser   # browser / edge runtimes
npm install @struktoai/mirage-vercel    # Vercel AI adapter; each agent framework has its own package

CLI

curl -fsSL https://strukto.ai/mirage/install.sh | sh
# or
npm install -g @struktoai/mirage-cli
# or
uvx --from mirage-ai mirage
# or
npx @struktoai/mirage-cli

Continue with the Python, Node, browser, or CLI quickstart.

More Details

Python

VFS extras, virtualenv setup, and uv workflow.

TypeScript

Native peers (FUSE, Redis) and per-runtime notes for Node, browser, and edge.

Getting Started

Examples

Agents

VFS

Integration

CLIs

Mirage Shell

Agent Profiles

Policy

Runtimes

Infrastructure

Configuration

Notifications

Help

Prerequisites

Python

TypeScript

CLI

More Details

Python

TypeScript

​Prerequisites

​Python

​TypeScript

​CLI

​More Details

Python

TypeScript

Prerequisites

Python

TypeScript

CLI

More Details