1014029855/dsh-codevault

Records what you understood while reading open-source code — quick notes and deep notes grouped into one card per repo/file/symbol, stored as Markdown you can open in Obsidian.

Project Overview项目介绍

This is a code reading archive plugin for DeepSeek Harness. It archives code reading notes by repository, file and symbol, merges multiple reads of the same code into one card, and supports linking with Obsidian vaults. Use it when reading open source code to record your understanding for later review. It requires configuration to connect to Obsidian, and all data is stored locally.

这是DeepSeek Harness的源码阅读归档插件,支持按仓库、文件、符号归档你的代码阅读笔记,同一段代码的多次阅读会合并到同一张卡片,可联动Obsidian知识库。适合阅读开源代码时记录理解,方便后续回看。注意需配置才能连接Obsidian,所有数据存储在本地。

Pre-install check安装前体检Compatibility · Security兼容性 · 安全性 1 warning1 项注意
  • Only 3 stars - very few users, little community feedback星标只有 3,几乎没人在用,遇到问题缺少社区反馈
DSH walks through these 9 checksDSH 会逐条核对这 9 项

Compatibility兼容性

  • DSH, Node, OS and profile requirementsDSH 版本 / Node 版本 / 操作系统 / profile 是否满足要求
  • External dependencies and runtimes (Electron / Python / Docker, ...)外部依赖与运行时(Electron / Python / Docker 等)是否齐备
  • Conflicts with installed plugins: command names, skill / tool names, ports, duplicate MCP registration与已装插件是否冲突:命令名、skill / tool 重名、端口占用、重复 MCP 注册

Security安全性

  • Repo matches the facts registered here; archived or abandoned?仓库是否与页面登记一致,是否归档或长期停更
  • Safety of preinstall / install / postinstall and install.sh / setup.ps1preinstall / install / postinstall 与 install.sh、setup.ps1 是否安全
  • curl|bash, download-then-execute, obfuscation, unrelated domains → stop immediatelycurl|bash、下载即执行、混淆代码、无关域名 → 立刻停止
  • Typosquatting or unmaintained packages among the new dependencies新增依赖里有没有 typosquatting 或无人维护的包
  • Requested permissions vs. what the feature actually needs申请了哪些权限、是否超出功能所需(filesystem / network / shell / clipboard)
  • Any sudo / admin requirement, plus uninstall and rollback是否要求 sudo / 管理员权限,以及卸载与回滚方式

Anything uncertain must be marked unknown with a note on how to confirm it. This site's signal screen is a static snapshot, not a security audit.拿不准的必须标「未知」并说明要我怎么确认。本站的信号筛查是静态快照,不能替代安全审计。

Or use CLI install (for developers)或使用命令行安装(适合开发者)

CLI Install命令行安装

dsh plugin --profile web add dshmarket

把 1014029855/dsh-codevault 加入你的 DSH 配置(web profile)即可启用。

READMEREADME

dsh-codevault · 源码阅读档案

dsh plugin release license

读开源代码的时候,我们经常"这次懂了,下次又忘了"。这个插件干的事很简单:在读懂的那一刻记一笔,按仓库、文件、符号归档,以后想回看随时能翻出来。

档案就是 Markdown + JSONL 文件,可以直接用 Obsidian 打开。同一个对象(比如 plugin.ts 的 apply 机制)读多少次都记在同一张卡上,卡片会随着你的阅读长起来,不是一条条碎片流水账。

安装

已装 dsh-market 的话:

dsh plugin --profile web add dshmarket      # 第一次先装市场
# 然后在市场里搜 "dsh-codevault" 一键安装

或者手动:

dsh plugin --profile web add dsh-codevault

重启 dsh web,启动日志里出现 [dsh-codevault] loaded 就算装好了。

配置

数据默认写在 <DSH_HOME>/data/dsh-codevault/。建议把 dataDir 指到 Obsidian vault(或它的子目录),改 profile 的 cordis.patch.yml:

# <DSH_HOME>/profiles/web/cordis.patch.yml
- id: dsh-codevault
  config:
    # 档案写入位置:默认 ~/.dsh/data/dsh-codevault;放进 Obsidian vault(或其子目录)最顺手
    dataDir: 'D:/Obsidian/源码阅读'
    # 可选:你的 Obsidian vault 根目录。配了之后模型才能只读搜你的笔记、给卡片挂链接
    vaultDir: 'D:/Obsidian'

改 dataDir/vaultDir 会触发 cordis 热替换,不用重启(新会话生效)。改环境变量 DSCODEVAULT_DATA_DIR 则要重启 dsh web。

配了 vaultDir 后,对话里模型可以只读检索你 vault 里的笔记(vault_search / vault_read / vault_suggest),找到值得关联的旧笔记,你确认后由 read_link 把 [[链接]] 补到卡片上。插件对 vault 只读,不会改动其他笔记。

怎么用

读完一个文件或机制,直接说:

把刚才读到的记一下:deepseek-harness 的 src/core/plugin.ts,apply 是插件入口。

模型会写 2–4 句要点(这个机制做了什么、关键点在哪、为什么这样设计)并起个标题。觉得值得深挖的,就说:

给 cordis 的 service 注入机制写一篇深读笔记。

它会按内置的 code-reading 技能框架写(对象坐标 → 机制 → 提炼/比较 → 存疑与回访),要求 ≥200 字。

几个常见场景:

  • 重读同一段代码:直接再记一次。不会开新卡,新事件会追加到那张卡的时间线里,顶部的 readCount 加一,各次提炼的要点去重合并。
  • 先记后深:读到一半先快记保底,之后说"把刚才那条 apply 的快记展开成深读笔记",read_expand 会把这条快记原位升级成深读,同一张卡重写,文件名和链接都不漂移。
  • 回看:问"我最近读了哪些对象?"、"deepseek-harness 里读过什么?",或输入 /codevault(用法)、/codevault recent(最近快照)、/codevault history(历史回放)、/codevault vault(当前数据目录与 Obsidian 接入指引)。
  • 串起旧知识:问"有没有我早先写过、和这个机制相关的笔记?",vault_suggest 会给候选,你挑几篇,read_link 补链,卡片末尾会出现"关联 vault 笔记"一节。
  • 回看当时的理解:问"这个机制我上次是怎么理解的?",read_history 会把那张卡倒回到第 N 次阅读或某个日期之前的版本——事件流只追加,所以任意时点的卡片都能精确重放。
  • 记错了就删:说"把刚才那条删掉",read_delete 移除该条事件并重建卡片(需要确认,删了不可恢复)。

Showing the opening section of the README — the full document lives in the repository以上为 README 开头摘要,完整文档在仓库内 · View the full README on GitHub →在 GitHub 查看完整 README →

← 上一个 Prev BigLead 下一个 Next dsh-plugin-mlquant-benchmark →