zhaohongxuan/dsh-weread

选用指南

AI 根据 README 整理 · 2026/11/5 21:37:12

使用方式

作为 dsh 插件使用，需先安装并构建，然后在 dsh Web GUI 中启用，通过左侧栏入口访问。

查看 README 依据

npm install --cache ./.npm-cache # 本机全局 npm cache 属 root 时需换目录 npm run build # 产出 lib/index.js + lib/client.js bash scripts/link-profile.sh web # 等价 dsh plugin --profile web add --save-prod file:$PWD ``` 然后：**dsh Web GUI → 设置 → 插件 → 打开 `dsh-weread` → 刷新页面**。左侧栏会出现「微信读书」入口。 ## 🔑 配置 API Key 1. 打开 **dsh 全局设置 → 微信读书**。 2. 访问 <https://weread.qq.com/api/skills/apikeyGet>（已登录微信读书时直接返回 apikey），复制粘贴到输入框。 3. 点「保存并校验」，显示已授权即可。 > 💡 若提示「网络出口被风控拦截（403）」而 Key 本身有效，是当前出口 IP 被微信读书限制，配置可访问微信读书的代理即可（`config.json` 的 `proxy` 字段）。 ## 🗂️ 书架数据源

部署要求

需要已配置 DSH_HOME 且 profile 为 web 的 DeepSeek Harness 环境，并需在微信读书获取 API Key 配置到 dsh 全局设置。

查看 README 依据

├─ store/journalCache 按账号 JSON 缓存 + 24 小时增量同步 + 断点恢复 └─ ai/ ctx.llm.stream 流式总结 ``` - **认证**：仅 API Key（不依赖 Cookie）。Key 只存 `$DSH_HOME/storages/dsh-weread/config.json`（权限 600），浏览器只见 `wrk-****1234` 掩码。 - **数据代理**：所有微信读书请求都在宿主侧发出，浏览器只访问同源 `/api/weread/*`（认证/路由由 dsh 连接层负责）。 - **AI**：复用 dsh 已配置的模型（默认 `provider=magpie`、`model=workbuddy/deepseek-v4.1-flash`），无需额外密钥。 ## 🚀 安装 前提：`DSH_HOME` 已配置（如 `/volume2/docker/dsh/home`），profile 为 `web`。 ```bash git clone https://github.com/zhaohongxuan/dsh-weread.git cd dsh-weread

npm install --cache ./.npm-cache # 本机全局 npm cache 属 root 时需换目录 npm run build # 产出 lib/index.js + lib/client.js bash scripts/link-profile.sh web # 等价 dsh plugin --profile web add --save-prod file:$PWD ``` 然后：**dsh Web GUI → 设置 → 插件 → 打开 `dsh-weread` → 刷新页面**。左侧栏会出现「微信读书」入口。 ## 🔑 配置 API Key 1. 打开 **dsh 全局设置 → 微信读书**。 2. 访问 <https://weread.qq.com/api/skills/apikeyGet>（已登录微信读书时直接返回 apikey），复制粘贴到输入框。 3. 点「保存并校验」，显示已授权即可。 > 💡 若提示「网络出口被风控拦截（403）」而 Key 本身有效，是当前出口 IP 被微信读书限制，配置可访问微信读书的代理即可（`config.json` 的 `proxy` 字段）。 ## 🗂️ 书架数据源

已知限制

有声书卡片不可点击，今日书单仅覆盖当前书架可识别的电子书，阅读时长可能包含听书，跨时区使用时日期边界可能不同。

查看 README 依据

设置页的「书架数据源」开关决定书架标签页读哪一份数据（**默认书架模式**）： | 模式 | 接口 | 内容 | |---|---|---| | **书架模式**（默认） | `/shelf/sync` | 书架上的全部书、你的**文件夹（书单）**、**有声书（专辑）**；文件夹与书混排，文件夹卡片显示内部封面拼贴 | | 笔记模式 | `/user/notebooks` | 只列出**有笔记的书**，带笔记/想法数量，可按分类与阅读年份分组 | - 书架模式下点文件夹进入**文件夹页**（面包屑 + 返回），页内保持微信读书 App 里的原始顺序。 - 切换后点面板右上角 **⟳ 刷新** 生效；选择会持久化在 `$DSH_HOME/storages/dsh-weread/config.json`。 - 「有笔记」筛选与笔记角标只在笔记模式出现——书架接口不返回每本书的笔记数。 - 有声书卡片不可点击：`albumId` 与 `bookId` 是两个 id 空间，书籍详情页取不到专辑数据。 ## ☀️ 今日与回顾 打开插件默认进入「今日」。阅读／收听时长取当月统计的日级数据，今天读过的电子书取真实书架的最近阅读时间；点击书名查看详情，也可以跳回微信读书继续阅读。

- 每日同步只先读一次笔记本概览，比较各书的划线数、想法／评论数及笔记更新时间：未变化的书直接复用缓存，只查询新增或变化书籍的内容。 - 回顾笔记、那年今日和旧句均展示书籍封面、书名、作者与章节；点击封面进入详情。封面使用缓存中已有地址，缺失或加载失败时显示占位。 - 当日数字在首次整理完成前属于已加载部分；回顾日历表示有笔记的日期，**不代表这些日期的完整阅读流水**。 - 今日书单只覆盖当前书架可识别的电子书；阅读／收听时长可能还包含听书，因此不能据此推算每本书当天的阅读时长。 - 日期跟随浏览器本地时区，阅读时长跟随微信读书上游的日级统计分桶；跨时区使用时，两者的日期边界可能不同。 ## 🧑‍💻 开发 ```bash npm run build # 构建 host + client npm run dev # 监听 src，改动即重建 npm run typecheck # tsc --noEmit（host 侧） npm test # 解析器/配置/版本单测（node --test） ``` 发版时同步三处：`package.json` 的 `version`、`VERSION` 文件、`CHANGELOG.md` 的版本小节。