dsh-codevault:源码阅读档案

前言

阅读开源代码时,我们经常遇到“这次懂了,下次又忘了”的情况。dsh-codevault 插件旨在解决这个问题。它记录你在理解的那一刻的笔记,将它们按仓库、文件或符号分组,并以 Markdown 格式存储,以便在 Obsidian 中打开。

插件简介

dsh-codevault 是 DeepSeek Harness (DSH) 的一个插件。它归档了你对开源代码的理解。它由 1014029855 维护。它解决了在阅读过程中遗忘细节的问题,将笔记组织成卡片。

核心能力

插件提供以下功能:

  1. 归档记录:按仓库、文件、符号归档记录。
  2. 数据格式:存储 Markdown + JSONL 文件,可直接在 Obsidian 打开。
  3. 版本历史:支持版本历史回放,查看任意时点的卡片状态。
  4. Obsidian 集成:与 Obsidian Vault 集成(只读搜索、自动链接)。
  5. 工具集:内置 11 个工具(快记、深读、查询、删除、历史回放等)。
  6. 技能框架:提供 code-reading 技能框架,用于结构化深读笔记。

安装与启用

安装插件需要先确认是否已安装 dsh-market。

1、在终端执行以下命令安装市场(如果是第一次):

dsh plugin --profile web add dshmarket

2、在 DSH 市场中搜索 “dsh-codevault” 并一键安装。

3、或者手动安装:

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。

使用方式

插件提供 11 个工具和 /codevault 命令,支持快记、深读、历史回放和 Vault 关联。

  1. 快记
    读到关键点时,直接让模型记录。例如:

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

模型会写 2–4 句要点并生成标题。

  1. 深读
    对某个机制进行深度剖析。例如:

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

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

  1. 重读与追加
    重新阅读同一对象,不需要再给标题。新事件会追加到同一张卡的时间线里,顶部的 readCount 加一,各次提炼的要点去重合并。

  2. 命令操作
    使用 /codevault 系列命令:
    - /codevault:用法说明。
    - /codevault recent:最近读过的对象。
    - /codevault history:历史回放。
    - /codevault vault:当前数据目录与 Obsidian 接入指引。

  3. Vault 关联
    配置 vaultDir 后,可以使用以下工具:
    - vault_suggest:检索已有笔记,找出值得关联的旧笔记。
    - read_link:确认后补全结构化链接 [[链接]]。
    - vault_search / vault_read:只读检索你的 vault。

  4. 回访与删除
    - 每次记录可附带回访问题,卡片末尾会生成“回访问题”小节。
    - 说“把刚才那条删掉”,使用 read_delete 移除记录(需确认)。
    - 使用 read_history 回放到第 N 次阅读或某个日期之前的版本。

注意事项

  1. 纯本地运行:插件不联网、不调用外部 API、不读仓库,只写自己的数据目录。
  2. 标签纪律:tags 只接受档案里已有的标签。档案还没有标签时,第一批记录的标签会成为词表起点,之后新增主题词使用 newTags。
  3. 操作确认:删除记录、升级深读等操作需要用户确认。
  4. 无评分机制:插件不评分,无印象分,只记录你读懂了什么。

结语

dsh-codevault 旨在将代码阅读过程转化为可追溯的知识资产。通过事件流存储和版本回放,它帮你留住对代码的理解,并在 Obsidian 中构建可视化的知识图谱。更多详情请访问 GitHub。

羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜