README.md 2.2 KB
description: "The workspace group map: the persistent workspace entity family, durable directory records, and header-validated session membership, for users and maintainers navigating the group."
kind: "package-group"
packages/workspace
English | 中文
Summary
The workspace group provides the durable project list behind a host UI: one product package, workspace, that names user directories as projects, keeps them in a stable order, and groups each project's sessions under it. With it, a UI can show a sidebar of projects with their sessions, hide a session from the grouping without deleting it, and remove a project — removal never deletes the folder or the session histories, which become ungrouped. The group is host-side only: no tools, prompts, or session events, so the model and the agent loop never see it. Use it when the product shows a persistent workspace or project surface; it needs a session store and a persistence backend alongside it.
Table of Contents
Packages
| Package | Role | ctx key |
|---|---|---|
workspace |
Provides named, ordered projects with the sessions that ran in each directory | ctx.workspaceRegistry |
Related documentation
- Workspace subsystem — the authoritative feature contract for projects and their sessions.
- domain KV storage Agent Note — the storage design behind project records.
- Workspace UI product-flow Agent Note — how the first start builds projects from session history and how the GUI orders them.
- Workspace registration deletion decision — why removing a project never deletes its folder or sessions.