Mem0

Mem0VFS is a browser-safe, read-only view of one Mem0 user, agent, or run scope. Every memory is rendered as <memory-id>.json; the search CLI performs semantic search in that same scope.

Mem0 API keys are secrets. Use this VFS from Node or another trusted runtime; do not embed a Platform API key in a public browser bundle. Browser applications should call a server-side proxy instead.

import { Mem0VFS, MountMode, SEARCH, Workspace } from '@struktoai/mirage-node'

const memories = new Mem0VFS({
  apiKey: process.env.MEM0_API_KEY!,
  userId: 'alex',
})

const ws = new Workspace({ '/memories': memories }, { mode: MountMode.READ })
ws.registerCli('search', SEARCH)
await ws.shell('ls /memories/')
await ws.shell('search --top-k 5 "quarterly planning" /memories/')

Exactly one of userId, agentId, or runId is required.

Field	Description
`timeout` default `DEFAULT_TIMEOUT`	Seconds a request may wait to connect, or between two reads of its answer, before it fails; a download that keeps flowing is never cut off.
`apiKey` required, secret	Mem0 Platform API key.
`host` default `'https://api.mem0.ai'`	Mem0 API base URL.
`userId`	Mount this user’s memories. Set exactly one of `userId`, `agentId` and `runId`.
`agentId`	Mount this agent’s memories. Set exactly one of `userId`, `agentId` and `runId`.
`runId`	Mount this run’s memories. Set exactly one of `userId`, `agentId` and `runId`.
`defaultPageSize` default `100`	Memories fetched per request while listing the scope.
`defaultSearchLimit` default `10`	How many results `search` returns unless the line sets `top_k`.

Fields marked secret are redacted in snapshots. The TypeScript VFS mirrors the Python Mem0 VFS, including pagination, JSON rendering, score formatting, path-limited search, and --threshold.

VFS.md

The VFS.md an agent reads with Mem0 mounted at /<path>.

Rendered
Raw

Virtual Filesystem

Path	Description
`/<path>`	`mem0`, read

`/<path>` layout

/<path>
  <memory-id>.json

Supported Unix Commands for VFS

Unix commands work on each path as on a local filesystem, as far as the path supports them:

Path	Supported
`/<path>`	Commands that read files (`ls`, `cat`, `grep`, `find`, `jq` and the rest).

Limitations of Unix Commands for VFS

Where a path differs from a local filesystem:

Path	Limitations
`/<path>`	Read only: no command changes files. `grep -r`, `find` and `du` stop after 1000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused.

Run man to list every command, and man <cmd> or <cmd> --help for one command’s usage.

---
name: workspace-filesystem
description: The virtual filesystem layout of this workspace.
---

# Virtual Filesystem

| Path | Description |
| --- | --- |
| `/<path>` | `mem0`, read |

## `/<path>` layout

```text
/<path>
  <memory-id>.json
```

## Supported Unix Commands for VFS

Unix commands work on each path as on a local filesystem, as far as the path supports them:

| Path | Supported |
| --- | --- |
| `/<path>` | Commands that read files (`ls`, `cat`, `grep`, `find`, `jq` and the rest). |

## Limitations of Unix Commands for VFS

Where a path differs from a local filesystem:

| Path | Limitations |
| --- | --- |
| `/<path>` | Read only: no command changes files. `grep -r`, `find` and `du` stop after 1000 files; a glob matching more, `tar -c`, `cp -r` and `rm -r` are refused. |

Run `man` to list every command, and `man <cmd>` or `<cmd> --help` for one command's usage.

Getting Started

Access

AI Agents

VFS

CLIs

Runtimes

VFS.md

Virtual Filesystem

`/<path>` layout

Supported Unix Commands for VFS

Limitations of Unix Commands for VFS

​VFS.md

​Virtual Filesystem

​/<path> layout

​Supported Unix Commands for VFS

​Limitations of Unix Commands for VFS

VFS.md

Virtual Filesystem

`/<path>` layout

Supported Unix Commands for VFS

Limitations of Unix Commands for VFS