Quick Install
Mirage needs Python 3.12 or newer. In a uv project, install the base package:uv pip install mirage-ai or
python -m pip install mirage-ai does the same.
The base package ships the workspace, the RAM and Disk VFS and the shell, and
is enough to follow the Python Quickstart.
Optional Extras
Service SDKs and native libraries live in extras. Add an extra only for the storage, machine or agent SDK you use, withuv add "mirage-ai[<extra>]":
A VFS that talks HTTP, such as Slack, Notion or the Hugging Face Hub, needs no
extra.
The mirage CLI
To use only the mirage CLI, run it with uvx or install it on PATH:
uv tool install --upgrade mirage-ai upgrades it.
Install From Source
Building from source needs Rust 1.88 or newer. Install it with rustup. To contribute to Mirage or run the examples:Next steps
Quickstart
A workspace, a shell line and its result, in a few lines.
Virtualize data storage
S3, Slack, Google Drive, Postgres and 50+ more, as files.
Mount as a folder
Expose mounts to other programs through FUSE.
Connect an agent
The Python agent SDKs, wired to one workspace.