前言¶
閱讀開源代碼時,我們經常遇到“這次懂了,下次又忘了”的情況。dsh-codevault 插件旨在解決這個問題。它記錄你在理解的那一刻的筆記,將它們按倉庫、文件或符號分組,並以 Markdown 格式存儲,以便在 Obsidian 中打開。
插件簡介¶
dsh-codevault 是 DeepSeek Harness (DSH) 的一個插件。它歸檔了你對開源代碼的理解。它由 1014029855 維護。它解決了在閱讀過程中遺忘細節的問題,將筆記組織成卡片。
核心能力¶
插件提供以下功能:
- 歸檔記錄:按倉庫、文件、符號歸檔記錄。
- 數據格式:存儲 Markdown + JSONL 文件,可直接在 Obsidian 打開。
- 版本歷史:支持版本歷史回放,查看任意時點的卡片狀態。
- Obsidian 集成:與 Obsidian Vault 集成(只讀搜索、自動鏈接)。
- 工具集:內置 11 個工具(快記、深讀、查詢、刪除、歷史回放等)。
- 技能框架:提供
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 關聯。
- 快記
讀到關鍵點時,直接讓模型記錄。例如:把剛纔讀到的記一下:deepseek-harness 的 src/core/plugin.ts,apply 是插件入口。
模型會寫 2–4 句要點並生成標題。
- 深讀
對某個機制進行深度剖析。例如:給 cordis 的 service 注入機制寫一篇深讀筆記。
模型會按照 code-reading 技能框架(對象座標 → 機制 → 提煉/比較 → 存疑與回訪)撰寫,字數要求 ≥200 字。
-
重讀與追加
重新閱讀同一對象,不需要再給標題。新事件會追加到同一張卡的時間線裏,頂部的readCount加一,各次提煉的要點去重合並。 -
命令操作
使用/codevault系列命令:
-/codevault:用法說明。
-/codevault recent:最近讀過的對象。
-/codevault history:歷史回放。
-/codevault vault:當前數據目錄與 Obsidian 接入指引。 -
Vault 關聯
配置vaultDir後,可以使用以下工具:
-vault_suggest:檢索已有筆記,找出值得關聯的舊筆記。
-read_link:確認後補全結構化鏈接[[鏈接]]。
-vault_search/vault_read:只讀檢索你的 vault。 -
回訪與刪除
- 每次記錄可附帶回訪問題,卡片末尾會生成“回訪問題”小節。
- 說“把剛纔那條刪掉”,使用read_delete移除記錄(需確認)。
- 使用read_history回放到第 N 次閱讀或某個日期之前的版本。
注意事項¶
- 純本地運行:插件不聯網、不調用外部 API、不讀倉庫,只寫自己的數據目錄。
- 標籤紀律:
tags只接受檔案裏已有的標籤。檔案還沒有標籤時,第一批記錄的標籤會成爲詞表起點,之後新增主題詞使用newTags。 - 操作確認:刪除記錄、升級深讀等操作需要用戶確認。
- 無評分機制:插件不評分,無印象分,只記錄你讀懂了什麼。
結語¶
dsh-codevault 旨在將代碼閱讀過程轉化爲可追溯的知識資產。通過事件流存儲和版本回放,它幫你留住對代碼的理解,並在 Obsidian 中構建可視化的知識圖譜。更多詳情請訪問 GitHub。