@nuzo/memory-core
v1.1.0
Published
Core memory lifecycle, ports, and domain contracts for Nuzo.
Maintainers
Readme
@nuzo/memory-core
The host-neutral memory engine for Nuzo.
This package contains the memory lifecycle behavior, policy checks, SQLite
storage, FTS recall, audit events, and portable import/export contracts used by
@nuzo/memory.
Most users should install @nuzo/memory instead. Use this package directly
when you are building a library-level integration or contributing to Nuzo
itself.
Product Boundary
Nuzo is intentionally local-first. SQLite is part of the product boundary, not a placeholder for a required cloud database.
By default, Nuzo should not:
- send memories to a remote service;
- call embedding APIs;
- enable telemetry;
- hide inferred memory writes from the user.
Retrieval Model
SQLite FTS is the default retrieval path. The optional semantic contracts are inert unless a library caller supplies a provider, builds a derived sidecar, and explicitly requests semantic or hybrid retrieval. Canonical writes never invoke an embedding provider.
The benchmark-proven local provider uses an optional peer dependency so normal installs do not include an inference runtime or model:
npm install @nuzo/memory-core @huggingface/[email protected]Model provisioning is a separate explicit operation. Provider creation and normal recall only accept the pinned, checksum-verified local model files and disable remote model loading.
Use When
Use @nuzo/memory-core when you are:
- building a library-level integration with Nuzo;
- contributing to Nuzo itself;
- writing a host wrapper that cannot use the MCP server directly.
Use @nuzo/memory for local command-line workflows, Codex, Claude Code, and
other MCP-compatible hosts.
Public API
The root entrypoint is explicit and documented. See:
https://nuzo.com.br/spec/memory-core-api/
Stable public exports cover the memory service, canonical memory/export types, runtime config helpers, default policy, local secret scanner, and domain error class. Lower-level SQLite, port, migration, and optional semantic/local-model exports are supported for advanced or experimental integrations as documented there.
Expected domain failures throw NuzoMemoryError. Use its code for
machine-readable handling; message is for humans, and details may be absent
where exposing details would leak unauthorized memory metadata.
Documentation: https://nuzo.com.br/
License: Apache-2.0
