README.md 2.6 KB
description: "The storage group map: durable non-session data through named backends and the typed domain data form, for users and maintainers navigating the group."
kind: "package-group"
packages/storage
English | 中文
Summary
The storage group gives a composition durable storage for everything that is not a session event log: workspace records, session sidecars, and other host-side application data. With it, host packages can persist typed records through a schema-validated domain form, choose between a human-readable JSON backend and a point-update SQLite backend, and receive a change event after every durable write. The family is optional and host-side only: it registers no tools, injects no prompts, and writes no session events, so the model and the agent loop never see it. Use it when the product keeps application state that must survive restarts; a composition with no such data can omit the whole group.
Table of Contents
Packages
| Package | Role | ctx key |
|---|---|---|
storage |
Connects registered backends with mounted data-form facilities | ctx.storage |
storage-json |
Stores each unit as one human-readable JSON file | registers backend json |
storage-sqlite |
Stores units as JSON documents in one SQLite database | registers backend sqlite |
storage-domain |
Provides schema-validated, change-emitting KV domains over routed backends | ctx.storageDomain |
Related documentation
- Storage subsystem — the authoritative contract: the backend contract, domain declaration, change events, and generated API.
- domain KV storage Agent Note — the design behind the family, the workspace consumer, and the deferred session-backend migration.
- Workspace subsystem — the first consumer of the domain data form.