Help us shape the future of Go! Take the 2026 Go Developer Survey

memory

module
v0.5.0-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2026 License: Apache-2.0

README

Memory

Memory is an independently running memory appliance for Agents. Its stable model-facing surface is deliberately small:

remember(text)
recall(query)

The appliance, rather than an Agent host, owns identity continuity, Spaces, Views, durable receipts, retrieval, classification, consolidation, lifecycle, and forgetting. The repository ships the standalone durable Core, the M2 host-integration boundary, and the versioned owner-management foundation.

Current capabilities

M0 froze the contract and M1 provides:

  • immutable durable receipts with separate processing state;
  • Realm, Identity, private/shared Space, View, Grant, issuer, capability, and idempotency state in a migrated SQLite authority;
  • independent per-Space FTS5 projections rebuildable from receipts;
  • owner locking, owner-only credentials and Unix Socket transport;
  • health, readiness, graceful shutdown, bootstrap, issue, issuer rotation, inspect, revoke, Remember, Recall, and FTS-rebuild commands;
  • semantic conformance plus a separate-process crash/restart harness proving acknowledged durability and restart idempotency.

The Memory-owned M2 boundary additionally provides:

  • exact local transport, API, and Core Profile handshake;
  • immutable service version and source revision in packaged memoryd binaries;
  • a public issuer plane that keeps issuer credentials outside request bodies;
  • a Go SDK for handshake, Runtime capability issuance/renewal, and native sidecar manifest verification;
  • make sidecar, which accepts only a clean exact HEAD and emits a native executable, SHA-256 manifest, and detached checksum.

M3 Governance and Production Safety additionally provides:

  • versioned memory.management.v1alpha1 wire types and Go client;
  • owner-authorized receipt search and provenance trace;
  • append-only, same-Space corrections that shadow rather than rewrite evidence;
  • idempotent hard deletion with content-free tombstones and resurrection prevention;
  • secret-free capacity, storage, receipt, projection, capability, restore, and rollback diagnostics;
  • recoverable management-bearer rotation plus memoryctl governance commands;
  • sensitive NDJSON export, streaming encrypted backup with a separate owner-only key, offline verified restore, storage-generation rotation, and a management-only verification state with explicit commit or rollback;
  • lossless offline upgrade preparation and supported native sidecar packaging for macOS on Apple silicon (darwin/arm64).

The baseline appliance remains useful with every model and Worker disabled. Other buildable platforms are preview-only until they receive native lifecycle evidence. Caelis integration is independently owned and pins an exact published Memory revision and sidecar digest.

The M4 Semantic Steward foundation additionally provides:

  • a versioned Steward protocol and typed ADD, MERGE, SUPERSEDE, and IGNORE proposal vocabulary;
  • migrated Record, immutable Revision/Evidence, profile, and durable Job state;
  • deterministic same-Space validation, optimistic Revisions, governance invalidation, and idempotent unknown-outcome recovery;
  • immutable model/prompt profile versions and future-Job Space bindings through the owner management plane;
  • an optional bounded shared Worker pool with HTTPS or loopback HTTP providers, owner-only out-of-band credentials, durable leases, retries, and terminal poisoning controls;
  • authorization-first per-Space semantic Recall, deterministic receipt/Record merge and deduplication with complete provenance;
  • receipt-only fallback with degraded=true, semantic projection rebuild, and secret-free profile, backlog, Record, Worker, and projection diagnostics.

Read the specification, roadmap, and acceptance plan before extending the API. Use the memoryd operations guide to run the standalone Golden Path. The release procedure owns M5 quality, native artifact, incident, upgrade, and publication gates. The corpus evaluation procedure measures privacy-safe multi-round behavior with local Markdown or Session JSONL sources.

Run the current gates with:

make check
make race
make durable
make release-candidate

The repository gates set GOWORK=off so the module remains independently buildable even when cloned beside a parent development workspace.

Directories

Path Synopsis
api
memory/management/v1alpha1
Package v1alpha1 defines the versioned owner-management contract for a Memory Appliance.
Package v1alpha1 defines the versioned owner-management contract for a Memory Appliance.
memory/steward/v1alpha1
Package v1alpha1 defines the versioned proposal and semantic-record contract between the Memory Appliance and a replaceable Steward provider.
Package v1alpha1 defines the versioned proposal and semantic-record contract between the Memory Appliance and a replaceable Steward provider.
memory/v1alpha1
Package v1alpha1 defines the transport-neutral memory.v1alpha1 contract.
Package v1alpha1 defines the transport-neutral memory.v1alpha1 contract.
cmd
memoryctl command
memoryd command
memorymanifest command
Package conformance provides reusable M0 semantic tests for memory.v1alpha1 implementations.
Package conformance provides reusable M0 semantic tests for memory.v1alpha1 implementations.
internal
appliance
Package appliance implements the standalone durable Memory appliance.
Package appliance implements the standalone durable Memory appliance.
backupfile
Package backupfile owns the encrypted streaming container used by memoryctl.
Package backupfile owns the encrypted streaming container used by memoryctl.
buildinfo
Package buildinfo owns immutable identity injected into the memoryd binary.
Package buildinfo owns immutable identity injected into the memoryd binary.
localtransport
Package localtransport owns memoryd's local HTTP composition and private M1 management endpoints.
Package localtransport owns memoryd's local HTTP composition and private M1 management endpoints.
steward
Package steward executes durable appliance-owned semantic Jobs with replaceable model providers.
Package steward executes durable appliance-owned semantic Jobs with replaceable model providers.
scripts
corpus_eval command
corpus_eval measures durable multi-round Remember and lexical Recall against private local material without emitting source text, queries, or receipts.
corpus_eval measures durable multi-round Remember and lexical Recall against private local material without emitting source text, queries, or receipts.
markdown_links command
sdk
go/memory
Package memory provides the host-side Go SDK for memory.v1alpha1.
Package memory provides the host-side Go SDK for memory.v1alpha1.
go/memory/local
Package local implements the versioned local memoryd transport.
Package local implements the versioned local memoryd transport.
go/memory/management
Package management provides the owner-authorized local management client.
Package management provides the owner-authorized local management client.
go/memory/sidecar
Package sidecar verifies a packaged memoryd before a host launches it.
Package sidecar verifies a packaged memoryd before a host launches it.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL