Skip to main content

dsh-client-ui-obsidian-memory

9Stars0Forks0Issues0Watchers

Provides persistent memory for DSH Web GUI using a local Markdown knowledge base, enabling AI to read, write, and search vault files with sidebar directory browsing.

Evidence5/5methodologySourceInstallMaintenanceDSH versionSecurity scan
Machine-auditedInstall commandRepo verifieddsh-plugin topicLicenseREADMEAI wiki

Install

cmdweb profile
$ dsh plugin --profile web add dsh-client-ui-obsidian-memory

Run the command above in your terminal to install this plugin via the dsh CLI. You can switch Profile in the top-right corner. New to dsh? Read the beginner tutorial

Install via your agent

Install the DeepSeek Harness plugin detongz/dsh-client-ui-obsidian-memory for me: review the repository at https://github.com/detongz/dsh-client-ui-obsidian-memory first, then run the install command and verify the plugin loads successfully.

Paste this instruction to the DSH Web GUI assistant — it will install and verify for you.

One-Sentence Description

Adds a local Markdown knowledge base (Obsidian vault) as persistent memory for the DeepSeek Harness (DSH) Web GUI, enabling the AI to read, list, search, write, and append vault files, with vault structure displayed as a directory browser in the sidebar.

Core Features

  • 5 vault file system tools: AI can read Markdown/text files, list directories and files, perform full-text search, write/overwrite files, and append content to file ends
  • Sidebar directory browser: Renders the vault directory tree in the DSH left sidebar sidebar.obsidian-memory slot, supporting breadcrumb navigation, refresh, vault selection via host directory picker, and "open with system" buttons for files/folders
  • Quick open shortcuts: Provides quick-open buttons for two commonly used files (AGENTS.md, TODO.md) in the vault root
  • Path sandbox protection: All file paths are resolved and validated for relative position; out-of-bounds access (.., empty relative paths) is rejected
  • Local Markdown persistence: Memory content is entirely carried by your own Markdown files; content written by AI is plain text that can be directly opened by note-taking software like Obsidian

Technical Implementation

  • Language: TypeScript (tsconfig.json target=ES2024, jsx=react-jsx, build tool rolldown)
  • Key dependencies: Zero runtime third-party dependencies; only uses Node built-in node:fs/promises, node:path for file I/O; browser side uses React 18 (peerDependency)
  • Architecture pattern: Dual-sided cordis plugin — host side (lib/index.js entry src/index.ts) registers 5 tools and system prompts in the Node host; client side (lib/client.js entry src/client/index.ts) registers a React panel in the browser sidebar via slots.inject('sidebar.obsidian-memory', ...); also auto-inserts ui-obsidian-memory node via package.json#dsh.bundle.patch + cordis.patch.yml
  • Entry files: Host side src/index.ts (exports name = 'ui-obsidian-memory', inject = ['tools', 'systemPrompt']); client side src/client/index.ts (inject = ['slots', 'workspaces', 'locale'])

Use Cases

Suitable for developers who want DSH's AI to remember "who, what project, unfinished tasks, daily notes" across sessions: use the Codex/ directory in your Obsidian (or any Markdown) knowledge base as AI's external memory, and AI will proactively write沉淀的内容 back to notes during conversations, which can be referenced in the next session. Also suitable for those who already use Obsidian as their primary note-taking tool and want AI to directly read/write these notes — no need to switch tools; the note software sees the same Markdown files.

Prerequisites and Compatibility

DependencyMinimum VersionDescription
DeepSeek Harness (DSH)>=0.1.0-rc.5All 4 peerDependencies (locale / runtime / sidebar / slots) require this version; the sidebar.obsidian-memory slot also depends on this version or newer builds
Node.jsNot declaredpackage.json has no engines field; source code only depends on Node built-in modules; tsconfig target is ES2024, recommend Node 22 or higher
DSH Web GUIRequiredPlugin runs on platform web (package.json#dsh.client.platform = "web"), must install DSH Web and have it running first
React^18.2.0 (peerDependency)Only used on client side; provided by DSH client runtime
@deepseek-ai/dsh-client-locale / -runtime / -ui-sidebar / -ui-slots>=0.1.0-rc.5 (peerDependency)All optional (peerDependenciesMeta.optional = true), provided by host DSH

Installation

dsh plugin --profile web add dsh-client-ui-obsidian-memory

Configuration Options

ConfigTypeDescriptionDefault
vaultPath (profile config / cordis.patch.yml ui-obsidian-memory.config)String (absolute path)Points to your local Codex/ (or any vault) root directory; all tool paths are resolved relative to this directory and sandboxed-
OBSIDIAN_VAULT_PATH (environment variable)String (absolute path)Fallback for plugin when vaultPath is not set in config; if neither is set, tool registration is skipped and a warning is logged-
localStorage['obsidian-memory:vaultPath'] (browser side)StringAfter you select a directory once via "Select Vault" in the sidebar, the panel remembers this path and auto-navigates on next open-

FAQ

Q: After installation, I can't see this plugin in Settings → Plugins. What should I do?

A: Most likely installed a version before 0.3.2 — dsh plugin add treated it as a regular dependency without activating it. Reinstall with @latest: dsh plugin --profile web add dsh-client-ui-obsidian-memory@latest.

Q: After installation, AI still can't see obsidian_memory_ tools. What should I do?*

A: Tools are only registered when vaultPath is configured. Add config.vaultPath to ui-obsidian-memory in your profile's cordis.patch.yml, or export the environment variable OBSIDIAN_VAULT_PATH; when neither is set, the plugin only logs a warning and skips registration.

Q: The sidebar doesn't show the "🧠 Obsidian Memory" panel. What should I do?

A: Requires DSH version with sidebar.obsidian-memory slot (≥ 0.1.0-rc.5); older DSH clients don't have this slot, so the panel has nowhere to live.

Q: Where is data stored? Will it be lost during migration/reinstall of DSH?

A: All data is your own local Markdown files, with paths determined by vaultPath; the plugin doesn't write any extra indexes or caches (only localStorage remembers the last selected path), reinstalling or migrating the host only requires pointing the new config to the original folder.

Q: Is writing safe? Can AI read files outside the vault?

A: All paths are resolved via relative validation after resolveVaultPath; out-of-bounds (.. or empty relative paths) throws Path traversal detected, forcing AI's read/write sandbox within vaultPath.

Q: What files can search cover?

A: Full-text search only looks at .md and .txt, skipping .git, .obsidian, node_modules three directories; other extensions (like .json, .csv) and files in ignored directories won't be indexed.

Q: What's the relationship with DSH's official memory feature?

A: This is a third-party plugin, neither dependent on nor replacing DSH's built-in memory capability; it exposes vault files as independent tools to the model, which can choose to read/write these Markdown notes within the prompt context.

Q: How to uninstall?

A: Remove the ui-obsidian-memory entry from your profile directory (delete OBSIDIAN_VAULT_PATH environment variable if needed), then dsh plugin --profile web remove dsh-client-ui-obsidian-memory, restart DSH — vault files won't be deleted.

Difficulty Level

Beginner — just fill in an absolute path in config (or export an environment variable), restart DSH to take effect; no code writing or internal template adjustment needed.

Known Issues and Limitations

  • Only .md and .txt files are indexed by obsidian_memory_search; JSON, CSV and other formats are not searchable; .git, .obsidian, node_modules directories are always skipped
  • Tool's output.render only converts results to text fragments for model output (e.g., search results include 200-character context window), no highlighting or navigation; to view full content, let AI use obsidian_memory_read
  • If vaultPath is not configured, the plugin only logs a warning and returns directly, not registering any tools; verify configuration is correct before enabling
  • 0.3.0 / 0.3.1 installation regression (missing dsh.bundle.patch, client loader id error) fixed in 0.3.2; if plugin still not recognized, confirm installation of 0.3.2+
  • Sidebar panel depends on DSH host providing workspaces.listDirectory / openPath / pickDirectory three capabilities; early or lite DSH may not have these host RPCs, making "Select Vault / Open Folder" buttons unavailable in the panel

Read the usage guide →

Install steps, key points, FAQ and compatibility for this plugin — auto-derived from indexed fields.

Listing badge

Listed on deepseek-plugin.org
[![Listed on deepseek-plugin.org](https://img.shields.io/badge/listed_on-deepseek--plugin.org-007EC6)](https://deepseek-plugin.org/plugins/detongz/dsh-client-ui-obsidian-memory)

Paste this markdown into your GitHub README to link back to this listing. The badge only states the listing — not a security endorsement.

← Back to plugin directory