Skip to main content

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.

​
Prerequisites

  • Python ≥ 3.12 for the mirage-ai package and the mirage CLI
  • Node.js ≥ 20 for the TypeScript SDK
  • 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.

​
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-agents    # OpenAI / Vercel AI / LangChain / Mastra adapters

​
CLI

curl -fsSL https://strukto.ai/mirage/install.sh | sh
Or via your package manager of choice: 
npm install -g @struktoai/mirage-cli

npx @struktoai/mirage-cli

uvx mirage-ai

​
More Details

https://mintcdn.com/struktoai/F9Lv_nTaj6By6crk/images/python-logo.svg?fit=max&auto=format&n=F9Lv_nTaj6By6crk&q=85&s=cf5b268d330f7db46ea5cf6083f309a1

Python

Resource extras, virtualenv setup, and uv workflow.
https://mintcdn.com/struktoai/F9Lv_nTaj6By6crk/images/typescript-logo.svg?fit=max&auto=format&n=F9Lv_nTaj6By6crk&q=85&s=63a620cb702b16103c53ea361a17504a

TypeScript

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