dsh-mnemon Documentation

September 4, 2026 · View on GitHub

简体中文 | English | Project home

This hub is organized by what you need to accomplish. New users should follow Getting Started, then use the visual guide for the interface. Existing v0.2.x users can go directly to the v0.3.0 release notes; reference documents are for deployment, integration, and development work.

New-user path

  1. Capability map: understand the three tiers, nine Providers, and which clicks start independent task Agents in 30 seconds.
  2. Roughly 55-second widescreen live demo: see paced full-page scrolling, Provider and dialog interactions, and a completed read-only Agent Query.
  3. Getting Started: install Mnemon and the plugin, choose storage, and complete first-run verification.
  4. Sidebar and conversation UI guide: learn Status, Runtime, Documents, Memory Spaces, and in-conversation entry points.
  5. Project overview: understand the three-tier model, cross-agent sharing boundary, read/write boundaries, and complete flow.

Find a task

I want to…Document
Grasp the current product scope and composable architectureCapability map · Architecture
Decide which tier should retain somethingStorage and the three-tier model
Choose, configure, or compare a Memory Space providerLong-term memory providers
Share durable memory between DSH and other Mnemon-enabled agentsProject overview: Cross-agent sharing · Configuration: Sharing scope
Learn when injection, recall, remembering, and archiving happenLifecycle and workflows
Configure global / workspace / custom storage, entry placement and visibilityConfiguration reference
Understand workspace inspection versus the Agent's effective directoryUI guide: Workspace mode
Check or update Mnemon and dsh-mnemonOperations: Version checks and updates
Back up, restore, or migrate the complete memory rootOperations: Backup and recovery
Publish the WebUI behind a cloud hostnameOperations: Cloud-hosted WebUI
Troubleshoot empty recall, misalignment, CLI, or provider errorsOperations and troubleshooting
Use model tools, /mnemon commands, or internal RPCInterface reference
Understand Host, workers, control plane, and data planeArchitecture
Build a Source, Strategy or Memory Spaces Provider pluginBuilding Memory Extensions
Modify code, screenshots, tests, or releasesDevelopment and verification
Upgrade to the current stable releasev0.5.1 release notes
Review the preceding release candidatev0.5.0-rc.1 scope and upgrade notes
See planned workRoadmap

Core terms

TermCode / alternate nameMeaning
Memory System记忆系统The complete dsh-mnemon entry in DSH
Runtime MemoryUSER / MEMORYHot memory projected into every turn
Project DocumentsDocuments / 档案Managed, searchable project knowledge that keeps full Markdown structure
Memory Space记忆体An independent, activatable, on-demand long-term-memory instance backed by Mnemon or an external Provider
Cross-agent memory sharing跨 Agent 共享Mnemon-enabled agents use the same root and Store to share durable memory, not the complete DSH context
RememberDistill / 沉淀Start an independent task Agent for qualification, dedupe, and writing
Recall召回Retrieve bounded evidence from active Memory Spaces
Archive归档Create a cold reference before moving an infrequently used Document out of active storage

Documentation boundaries

  • User documentation targets the Sidebar-first experience, optional shared Builtin placement and composable View architecture; legacy buildin preferences are normalized without manual cleanup.
  • Architecture diagrams describe stable execution boundaries, not live monitoring. Use Status for current counts and versions.
  • RPC is an internal Host-to-client protocol, not a promised stable external API.
  • There is no formal fixed DSH / Mnemon version matrix yet. Back up and validate in an isolated root before upgrading.