README.md 2.5 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 keeps non-session application data across restarts, including workspace records and session sidecars. Choose storage-json for human-readable files or storage-sqlite for point updates in one database; storage-domain adds schema-validated typed records and change notifications, while storage selects the configured backend. These packages are optional and host-side: they do not expose tools, prompt content, or session events to the model. Use the group when application state must outlive a process, and omit it when the composition has no such data.
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.