Skip to content

Define HotMem interchange and company-brain clone package v1 #67

Description

@valiantone

Summary

Define the versioned HotMem interchange contract used to transfer and clone a company brain.

JSONL is the canonical stream format. Compression is transport. A manifest provides integrity, provenance, and compatibility information.

Scope

  • Define hotmem-interchange-v1 JSONL record requirements.
  • Define manifest fields: schema version, record count, content digest, file digests, source identity, and compatibility requirements.
  • Define JSONL.GZ as the standard compressed transfer encoding.
  • Define idempotent hydration reporting: loaded, skipped, invalid.
  • Define stored-embedding reuse versus re-embedding behavior.
  • Reconcile the documented Snapshot v2 directory contract with active hydrate and snapshot behavior.
  • Add compatibility and round-trip fixtures.

Acceptance criteria

  • Written required, optional, and forward-compatible fields.
  • Verification occurs before hydration.
  • Equivalent contents have deterministic logical identity.
  • Existing JSONL and JSONL.GZ workflows remain supported.
  • A clean instance hydrates a valid package without duplicates.
  • Checksum mismatches fail with actionable diagnostics.

Out of scope

  • Encryption or signing.
  • Remote synchronization.
  • Multi-writer conflict resolution.
  • Required external databases or services.

Related documentation

docs/okf/company-brain-interchange.md
docs/snapshot-v2.md
docs/okf/file-native-memory-practices.md

Metadata

Metadata

Assignees

Labels

area:designArchitecture, RFC, ADR, roadmaparea:snapshotSnapshot v2 directory format, portability, replayenhancementNew feature or requestpriority:p0Critical path: do now; blocks the reproducible company-brain promisev0.2.xHotMem post-v0.2 follow-up work

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions