wehub-resource-sync
bcbd1bdb22
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
# mirage-fuse
|
|
|
|
Expose any mirage Workspace (memory, S3, R2, HTTP) as a native macOS directory so Claude Code and any CLI tool can read and write remote files transparently.
|
|
|
|
## Prerequisites
|
|
|
|
```bash
|
|
brew install --cask macfuse
|
|
uv add mirage-fuse
|
|
```
|
|
|
|
### macOS Security Setup
|
|
|
|
1. Open **System Settings → Privacy & Security**. Scroll to the bottom — you'll see:
|
|
|
|
> "System software from developer 'Benjamin Fleischer' was blocked from loading."
|
|
> Click **Allow**.
|
|
|
|
2. **Restart your Mac.** macOS requires a reboot to load the kernel extension.
|
|
1. If you don't see the Allow button (Apple Silicon M1/M2/M3/M4):
|
|
|
|
- Shut down completely
|
|
- Hold power button until "Loading startup options" appears
|
|
- Click **Options → Continue**
|
|
- In Recovery: **Utilities → Startup Security Utility**
|
|
- Set to **Reduced Security** and check **"Allow user management of kernel extensions"**
|
|
- Restart, then retry step 1
|
|
|
|
## Usage
|
|
|
|
### CLI
|
|
|
|
```bash
|
|
# Mount an in-memory workspace as a real directory (writable)
|
|
mirage mount-fuse /data/:memory:// --mountpoint /tmp/ws/ --mode write --foreground
|
|
# (runs in foreground — open a new terminal for the next commands)
|
|
|
|
# In another terminal: any OS tool works natively
|
|
ls /tmp/ws/data/
|
|
echo "hello" > /tmp/ws/data/notes.txt
|
|
cat /tmp/ws/data/notes.txt
|
|
|
|
# Use Claude Code directly on the mounted path
|
|
cd /tmp/ws/data && claude -p "write a hello.py script here"
|
|
|
|
# Ctrl+C in the first terminal to unmount
|
|
```
|
|
|
|
For read-only S3/R2 access:
|
|
|
|
```bash
|
|
mirage mount-fuse /data/:s3://my-bucket --mountpoint /tmp/s3/ --mode read
|
|
claude -p "summarize the files in /tmp/s3/data/reports/"
|
|
# Ctrl+C to unmount
|
|
```
|
|
|
|
### Python API
|
|
|
|
```python
|
|
from mirage.backend.local.memory import MemoryBackend
|
|
from mirage.workspace import Workspace
|
|
from mirage.fuse.fs import MirageFS, mount
|
|
|
|
ws = Workspace({"/data/": MemoryBackend()}, mode="write")
|
|
mount(ws, "/tmp/ws/", foreground=True)
|
|
```
|
|
|
|
## Supported FUSE Operations
|
|
|
|
| Operation | Description |
|
|
| ---------- | ----------------------- |
|
|
| `getattr` | File/directory metadata |
|
|
| `readdir` | List directory contents |
|
|
| `read` | Read file contents |
|
|
| `write` | Write file contents |
|
|
| `create` | Create new files |
|
|
| `mkdir` | Create directories |
|
|
| `unlink` | Delete files |
|
|
| `rename` | Move/rename files |
|
|
| `truncate` | Resize files |
|
|
| `open` | Open existing files |
|
|
| `release` | Close file handles |
|