AlexPeng07/dsh-custom-plugin

dsh-custom-plugin

npm version
license
Node
TypeScript
CI
Awesome DSH Plugin

DeepSeek Harness（DSH）Web GUI 的 Custom 便利套件：个性化外观、天气特效、玻璃效果、按用户消息的时间线导航、项目文件夹、增强提示词库、会话导出与会话搜索、Mermaid 渲染、引用回复、7/30/90 天用量分析、预算与无密钥本地备份，以及 Ctrl/Cmd+K 快捷面板。

插件为双半区架构：宿主半区（src/）持有状态文档、注册 /api/custom-plugin 路由与 custom_plugin_status 智能体工具；浏览器半区（src/client/）通过 7 个官方 slot 的 8 处注入挂载 UI，以同源 fetch 与宿主通信。经官方 profile 机制挂载，不改 DSH 源码。

部分界面展示

「设置 → 个性化」整页外观配置
会话头部弹出的同一套面板（浅色主题）

液态玻璃（Custom 面板位移折射）
时间线轨道与悬停预览

多级项目文件夹
Mermaid 思维导图就地渲染

余额与今日分模型用量
雨（三层景深）

樱花
飘雪

天气特效截自深色模式（深色下仅「无颜色」与「极光」背景可选）。额度历史、备份导入预览、会话搜索与快捷面板属于同一套动态面板，需在 DSH 内打开对应页查看；仓库未另附固定截图。

功能

外观个性化

- 背景颜色：20 组低饱和典雅色（每组合配 tab 栏色，默认「天青灰」），另有「无颜色」（跟随 GUI 默认主题）与高饱和「极光」渐变。深色模式下仅「无颜色」与「极光」可选，其余颜色禁用，插件文字自动转白保证可读性。
- 天气特效：画布渲染、不挡交互，一键切换——飘雪、电影感雨滴（三层景深 + 地面溅起）、樱花飘落；关闭时自动清空画布。
- 玻璃效果：所有 Custom 面板默认毛玻璃；可切换液态玻璃（Chromium 位移折射，无色散、轻微背景模糊；Safari/Firefox 自动回退毛玻璃）。「全局浮层玻璃」对弹窗、菜单、提示框、下拉框统一加模糊。

时间线导航

每条用户消息在右侧（或左侧）轨道生成一个节点：

- 悬停弹出预览卡（自动防溢出定位），卡内直接显示 LaTeX / MathML / Mermaid 标记；
- 点击跳转到对应消息（直接驱动聊天滚动容器，消息位于嵌套滚动区时也能居中）；
- 拖动滑块或在轨道上滚轮滚动（轨道替代原生滚动条）；
- 节点支持星标（可只显示星标）、在该消息处创建分支会话、一键复制全文。

节点按渲染出的用户消息行定位（DOM 行 sourcing），加载历史后自动刷新；轨道尾部最多保留 400 个节点。

项目文件夹

多级文件夹树，保存在 $DSH_HOME 状态文件中，跨工作区共享。任意工作区与会话都可收纳进文件夹；支持拖拽排序（插入前 / 内部 / 插入后）、重命名、删除与「添加当前会话」。

提示词库

提示词支持新增、编辑、复制、删除、搜索、收藏、标签和拖拽排序，并记录最近使用与使用次数。正文可使用 {{变量名}}；插入前会弹出变量表单。提示词库可用版本化 JSON 或以二级标题分段的 Markdown 导入导出。

会话导出

导出当前会话为三种格式（文件名带日期戳）：

- JSON：标准 messages 结构（user / assistant / tool），meta 携带会话标题、创建时间、工作目录与导出时间，可导入其他工具；
- Markdown：按角色分块的纯文本；
- PDF：A4 打印版式 HTML，浏览器打开后打印另存为 PDF；图片以 base64 内嵌（最多 30 张、总量 12 MB、单张 ≤ 4 MB）。

工具调用行携带工具名与参数摘要（从配对的 tool/call 事件解析）。

插件状态可导出为版本化 JSON 备份，包含外观、文件夹、提示词、星标、用量和预算，不包含 API Key 或凭据元数据。导入前显示冲突预览，支持合并或覆盖非敏感状态，并自动保留恢复副本。

Mermaid 渲染

聊天中的
效率工具

- 引用回复：选中对话文本后出现「引用回复」按钮，以引用块插入输入框；
- 防自动跳转：强制 scroll-behavior: auto，发送消息不再把视图拽到底部（默认关闭）；
- 公式复制：含公式的消息下方显示 LaTeX / MathML 复制按钮（MathML 可直接粘贴进 Word）；
- 批量归档：勾选多个会话批量归档，运行中会话默认不可选，并分别报告成功与失败数量；DSH 尚未公开恢复接口，插件不提供恢复入口。
- 会话搜索：通过 DSH 官方索引搜索当前会话的用户、助手和工具内容，点击结果跳转到所属轮次。
- 快捷面板：在非编辑状态按 Ctrl+K / Cmd+K，统一搜索会话、工作区、提示词和常用功能。
- 可靠归档：运行中的会话默认不可选，批量操作分别报告成功与失败数量。

额度与用量

会话头部常驻额度徽标（可点击固定），额度面板提供：

- 余额：调用官方 https://api.deepseek.com/user/balance 接口，优先显示 CNY，赠送与充值余额分列，并显示账户可用状态。
- Key 解析顺序：系统凭据存储（可用时）→ 插件旧状态文件中的 Key → 环境变量 DEEPSEEK_API_KEY / DEEPSEEK_KEY / DEEPSEEK_TOKEN（取值需以 sk- 开头）→ DSH 凭据文件 $DSH_HOME/.credentials.yaml（自动复用 DSH 已配置的 DeepSeek key，无需重复填写）。
- 今日用量：按模型统计输入 / 输出 / 缓存 token 与调用次数，实时折叠自 session/event 事件。
- 费用估算：按 DeepSeek 当前官方峰谷价目估算——高峰为北京时间周一至周五 9–12、14–18 时；其余时间（含周末）均为空闲时段，按半价计：deepseek-v4-flash / deepseek-v4-flash-vision-exp ¥3 / ¥9，deepseek-v4-pro ¥9 / ¥27（每百万 tokens 输入 / 输出，缓存写入 ¥0.1 / ¥0.3；已停用的 deepseek-chat / deepseek-reasoner 按 v4-flash 计），仅供参考。
- 扫描：「扫描今日会话日志」重放全部会话、按事件自身时间戳归入今日（跨午夜会话不丢量），完成后显示扫描到的活跃会话数。
- 历史与预算：查看 7 / 30 / 90 天趋势和按模型汇总，导出 UTF-8 CSV；可设置人民币月预算与预警比例。

设置入口

「设置 > 个性化」页提供外观与工具开关的整页配置；会话头部与侧边栏底部的「个性化」按钮打开同一套面板弹框。

智能体集成

custom_plugin_status 工具报告：外观配置、今日按模型用量、余额、时间线样本、Mermaid 引擎加载情况、状态文件路径与客户端诊断。插件不注入任何系统提示。

安装

前置：Node 22+、pnpm，以及 dsh CLI（官方 npm 包 @deepseek-ai/dsh；未全局安装时，可用 npx @deepseek-ai/dsh 代替 dsh）。

从 npm 安装
sh
dsh plugin --profile web add @alexpeng/dsh-custom-plugin
重启 dsh web

registry 上是预构建产物，安装端无需从源码构建。

从 GitHub 安装（源码安装）
sh
dsh plugin --profile web add github:AlexPeng07/dsh-custom-plugin
重启 dsh web

git 安装拉取的是源码，prepare 脚本会在安装端构建 lib/。pnpm ≥10 需要一次性授权该构建——把 pnpm 提示的确切包键复制进 profile 的 pnpm-workspace.yaml 的 allowBuilds 下，再重新执行 add。走上方 npm 路线可免去构建授权。

本地链接（开发）
sh
构建（本仓库根目录执行）
pnpm install
pnpm build
装入 web profile。链接路径不能含空格：Windows 上若源码路径含空格，
先创建无空格目录联接（如 F:\dsh-plugin-dev），再链接到联接路径
dsh plugin --profile web add link:F:/dsh-plugin-dev
重启 dsh web

包按官方组合包协议声明 manifest：package.json 的 dsh.bundle.patch 指向 cordis.patch.yml 配置层（行 id custom-plugin），dsh.client 声明浏览器半区。dsh plugin add 在 profile 目录内转发给 pnpm，安装后因该声明被自动加入 dsh.profile.bundles；浏览器半区经官方客户端模块系统按同一行加载。

配置

插件读写 $DSH_HOME/custom-plugin-state.json 单个 JSON 文档（默认 ~/.dsh，可用 DSH_HOME 环境变量覆盖），包含外观配置、文件夹、提示词、星标、兼容旧版的数据与最近 90 个北京时间日的用量账本；写入为原子写（临时文件 + 重命名），崩溃不会截断文档。

外观与功能开关（cfg 字段，均有默认值）：

| 配置项 | 默认值 | 说明 |
|---|---|---|
| bg | 天青灰 | default（无颜色）/ aurora（极光）/ 20 组调色板名之一 |
| weather | none | none / snow / rain / sakura |
| glass | true | Custom 面板玻璃总开关 |
| glassMode | frost | frost 毛玻璃 / liquid 液态玻璃 |
| globalGlass | true | 全局浮层（弹窗/菜单/提示）加模糊 |
| timeline | true | 时间线轨道开关 |
| timelineLeft | false | 轨道放左侧 |
| starsOnly | false | 只显示星标节点 |
| quote | true | 划词引用回复 |
| antiScroll | false | 防自动跳底 |
| mermaid | true | Mermaid 图表自动就地渲染（含消息下方渲染按钮） |
| formula | true | LaTeX / MathML 复制按钮 |
| monthlyBudgetCny | 0 | 人民币月预算；0 表示关闭提醒 |
| budgetWarningPercent | 80 | 月预算预警百分比（1–100） |

安全模型

- 浏览器仅通过回环地址上的 /api/custom-plugin 路由与宿主通信；每条路由同时校验回环 socket 地址、回环 Host 头与浏览器同源标记（sec-fetch-site / Origin），X-Forwarded-For 永不信任。
- 浏览器永远不会收到已保存的 DeepSeek API Key。面板新输入的 Key 在 keytar 存在时优先写入系统凭据存储；旧版状态文件中的明文 Key 会在系统存储可用时启动迁移。keytar 不再作为本插件的依赖发布（原生模块会触发 pnpm 11 的严格构建门禁，导致整个插件包安装后无法激活）；需要系统钥匙串的用户可自行加入 profile：dsh plugin --profile web add keytar。
- 如果系统凭据存储不可用，插件会兼容回退到 $DSH_HOME/custom-plugin-state.json；请相应保护 $DSH_HOME 目录。DSH 自身的 $DSH_HOME/.credentials.yaml 明文凭据仍可复用。
- 会话导出与时间线数据全部停留在本机。

已知限制

- Mermaid 引擎来自随插件安装的本地依赖，离线可用；仅当依赖缺失时回退 CDN 拉取（宿主在进程生命周期内缓存）。
- 用量账本折叠自实时 session/event 记录，只保留最近 90 个北京时间日；错过实时事件时可手动「扫描」，扫描最多并发读取 4 个会话日志。
- 额度面板会显示峰/闲 token 与费用分布，并提供官方价目链接；没有峰时字段的历史行会标记为“不精确”，不计入费用总额，重新扫描后可更新。
- 系统凭据存储会在宿主启动时检测 profile node_modules 中的 keytar 模块；无法加载时使用兼容的状态文件回退。
- 费用按 DeepSeek 官方峰谷单价估算，仅供参考。
- 深色模式下背景限制是刻意设计：仅「无颜色」与「极光」可选。
- DSH 当前没有公开的归档恢复接口；插件不会绕过官方边界修改底层注册表。

开发
sh
pnpm typecheck   # 类型检查
pnpm test        # vitest 单元测试
pnpm build       # 构建 node ESM 库与浏览器 bundle 到 lib/

许可证

Apache-2.0。部分代码参考 Nagi-ovo/voyager 与 unovue/inspira-ui。