> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install Mirage with the Python package mirage-ai or the TypeScript packages @struktoai/mirage-node and @struktoai/mirage-browser.

## 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

```bash theme={null}
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 runtimes that run `python3`, `node` and `js` inside Mirage are extras
too, and a workspace names the one it uses in `runtimes`:

```bash theme={null}
uv add 'mirage-ai[monty,quickjs]'
```

QuickJS also needs a `qjs-wasi.wasm` module; see
[QuickJS installation](https://docs.mirage.strukto.ai/home/setup/runtime/quickjs.md#installation).

## TypeScript

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

```bash theme={null}
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

```bash theme={null}
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](https://docs.mirage.strukto.ai/python/quickstart.md), [Node](https://docs.mirage.strukto.ai/typescript/quickstart.md),
[browser](https://docs.mirage.strukto.ai/typescript/browser-quickstart.md), or [CLI](https://docs.mirage.strukto.ai/home/access/cli.md#quickstart) quickstart.

## More Details

> [card] [Python](https://docs.mirage.strukto.ai/python/install.md)
>
> VFS extras, virtualenv setup, and `uv` workflow.

> [card] [TypeScript](https://docs.mirage.strukto.ai/typescript/install.md)
>
> Native peers (FUSE, Redis) and per-runtime notes for Node, browser, and edge.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.