Installation
Use Python 3.12 or newer. In a uv project, install Mirage with:Create a Workspace
Start with the RAM VFS, an in-memory filesystem mounted at/data that needs
no credentials.
quickstart.py
uv run python quickstart.py, or python quickstart.py in another
activated environment. Output:
MountMode.WRITE lets the shell create and change files under /data.
ws.shell does not raise when a command fails. Check result.exit_code, and
read the message with await result.stderr_str(). See the
in-app API reference.
Later pages show the body of an async def main(); run it with
asyncio.run(main()), as here.
Next steps
Virtualize data storage
S3, Slack, Google Drive, Postgres and 50+ more, as files.
Install CLIs
gh, git, Linear, Office and PDF tools in the same shell.Run programs on a machine
python3 and node in Mirage, on the host or in a sandbox.Connect an agent
The Python agent SDKs, wired to one workspace.
Set what an agent may do
Profiles, command rules, asks and hidden paths.
In-App API
Every workspace and session call, with an example.