Getting started

Patchouli contains two independently usable surfaces:

• a DeepSeek Harness plugin bundle that exposes the common Memory Service;
• the optional patchouli-db daemon for transactional local or remote storage.

The database backend is not required when every registered MemoryPlugin uses its own external service.

Requirements

• Node.js ^22.19.0 or >=24.0.0
• pnpm 11
• Rust stable when building patchouli-db from source
• a DeepSeek Harness runtime compatible with 0.1.0-rc.6

Install the DSH plugin from a checkout

git clone --branch main --single-branch https://github.com/memorax-ai/dsh-patchouli.git
cd dsh-patchouli
corepack enable
pnpm install
pnpm pack
dsh plugin --profile web add .
dsh --profile web --dump-config

The Web profile should include the core patchouli plugin, Agent Loop adapter, Artifact Ingestor, Session and Workspace Indexer boundaries, and durable memory cursor service.

Install the optional backend

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/memorax-ai/dsh-patchouli/main/scripts/install.sh | sh

Windows PowerShell

irm https://raw.githubusercontent.com/memorax-ai/dsh-patchouli/main/scripts/install.ps1 | iex

The installer verifies release checksums and initializes ~/.patchouli without overwriting existing configuration. It does not modify a DSH profile, register a system service, or start a background process. See Backend installation for platform details and source builds.

Configure the storage client

The default bundle enables the storage client. Configure it when plugins need a different daemon endpoint or auto-start behavior:

- id: patchouli-storage
  name: dsh-patchouli/storage
  config:
    autoStart: true

The client exposes daemon control, generic entity CRUD, retrieval, managed Artifact transfer, and cursor-based change subscriptions through ctx.patchouliStorage.

Next steps

• Configure Agent Loop hooks and consumers in DSH integration.
• Understand process and plugin boundaries in Architecture.
• Select identity and consistency rules in Backend configuration.
• Model files, knowledge, and relations with the Knowledge model.