Skip to main content

​
Quick Install

Mirage requires Python 3.12 or newer. In a uv project, install the base package with:
This is enough to start with local workflows such as the RAM VFS and to understand the Mirage execution model. In an activated standalone virtual environment, use either installer:

​
Use Mirage as a CLI

If you only want the mirage CLI (not the library), there are two convenient paths. One-shot run with uvx, no install, just runs:
Persistent install with uv tool install, drops mirage on your PATH globally:
To upgrade later:

​
VFS Extras

Install extras when a VFS needs optional dependencies:
Use the VFS docs in the Python section when you are ready to connect real systems.

​
Install From Source

If you are contributing to Mirage or want the full local development setup:
  1. Install the base package.
  2. Follow the Python Quickstart with the RAM VFS.
  3. Add the VFS extras and follow the FUSE setup if you need to expose mounts as a real filesystem.