@memofs/core

@memofs/core

         

MemoFS core memory runtime and provider-neutral contracts for AI apps and agents.

What is this?

Unified core memory runtime. Core memory contracts, records, chunks, source references, manifest validation, local protocol helpers, and provider-neutral runtime primitives — the MemoFS client, hybrid recall (BM25 + fuzzy + vector channel via file-based and in-memory stores), graph, snapshots, sync, and the provider-neutral MemoryEmbedder / Reranker / RecallStore contracts that adapters (OpenAI, Voyage, Transformers) implement.

Installation

npm install @memofs/core

# or: pnpm add @memofs/core
# or: yarn add @memofs/core
# or: bun add @memofs/core

Requires Node.js >= 22.

Quick Start

Create a MemoFS client with a filesystem store and read core memory:

import { MemoFS } from "@memofs/core";
import { createNodeFsMemoryStore } from "@memofs/core/node-fs";

const memo = new MemoFS({
  // The store root is your workspace; MemoFS creates `.memofs/` inside it.
  store: createNodeFsMemoryStore({ rootDir: "." }),
  projectId: "my-project",
  mode: "local",
});

await memo.bootstrap();

// Read core memory (returns raw markdown text)
const core = await memo.core.read();
console.log(core);

Runtime Boundaries

The root @memofs/core entry is Worker-loadable when you provide a Worker-safe MemoryStore. Node filesystem utilities live behind a separate subpath and must not be imported from a Worker.

• Root barrel: import { MemoFS, createInMemoryGraphStore, createFsRecallStore } from "@memofs/core"
• Node filesystem store: import { createNodeFsMemoryStore, createNodeMemoFs } from "@memofs/core/node-fs"
• Cloud client contracts: import { createMemoFsCloudClient } from "@memofs/core/cloud-client"

For Workers, inject a compatible store such as RemoteBlobMemoryStore with your blob and metadata adapters. The root package does not choose a storage backend for you.

Provider-specific adapters (OpenAI, Voyage, Transformers) live in separate @memofs/adapter-* packages — core defines the contracts, adapters implement them.

For a complete breakdown of configuration options, interfaces, and architecture, see our Full Documentation.

Boundary

This package owns the MemoFS core contracts, memory store adapters, and runtime primitives. It does not own private SaaS concerns such as billing, tenancy, hosted dashboards, encrypted BYOK storage, or internal admin tooling. All public API capabilities are consolidated and exported directly from the root namespace of @memofs/core.

Contributing

See our central Contributing Guide and development scripts for details on formatting, linting, and testing within the monorepo.

License

MIT