Overview

A local FUSE mount exposes a VFS as a folder on the machine running your Mirage workspace. Editors, scripts and other programs can use it like any other folder, even when the data lives in S3 or another remote service. Use it directly in your Python or TypeScript app, or configure it through the Mirage CLI. A server is not required when you use the SDK in your own app.

Support matrix

OS	Python	TypeScript (Node)	Notes
Linux	Supported	Supported	`fuse3`; multiple mounts per process
macOS	Supported	Supported	macFUSE; one mount per process
Windows	Experimental	Not supported	Python via WinFsp; write-heavy use and symlinks are not yet proven
Browser	Not supported	Not supported	Use Mirage’s shell and file APIs instead

Platform differences

	Linux	macOS	Windows
Unmount	`fusermount -u` or `ws.close()`	`diskutil unmount` or `ws.close()`	At process exit
Files with unknown size	Full content on read	Full content on read	Size fetched when opened
Mountpoint folder	Must exist	Must exist	Must not exist; created automatically

Install FUSE

Follow the Linux, macOS or Windows setup guide. Install your SDK’s FUSE binding using the Python or TypeScript instructions.

Try it with the CLI

On Linux or macOS, create a folder for the mount:

mkdir -p /tmp/mirage-data

Set backend: fuse and the local folder in your workspace config:

workspace.yaml

mounts:
  /data:
    vfs: ram
    mode: WRITE
    backend: fuse
    mountpoint: /tmp/mirage-data

Create the workspace, write a file through Mirage, and read it from the local folder:

mirage workspace create workspace.yaml --id demo
mirage shell -w demo -c 'echo "hello mirage" > /data/hello.txt'
cat /tmp/mirage-data/hello.txt

Output

hello mirage

Replace RAM with a supported VFS to expose your own data. The mount follows its configured access mode; a READ mount cannot be written to. Mounts configured this way are not tied to an agent session or profile. The folder is unmounted when the workspace closes. With the CLI:

mirage workspace delete demo

Getting Started

Agents

VFS

Integration

CLIs

Mirage Shell

Agent Profiles

Policy

Runtimes

Configuration

Notifications

Access

Help

Support matrix

Platform differences

Install FUSE

Try it with the CLI

​Support matrix

​Platform differences

​Install FUSE

​Try it with the CLI

Support matrix

Platform differences

Install FUSE

Try it with the CLI