一个基于 Chrome Side Panel 的微信读书可视化插件:使用你手动提供的 WEREAD_API_KEY 从微信读书官方接口同步只读数据,在本地生成个人阅读看板。
如果你是第一次拿到这个仓库、只想快速安装体验,请优先看:
INSTALL.md
它会告诉你:
- 依赖怎么装
- 扩展怎么 build
chrome://extensions里该选哪个目录- 如何开始体验当前 WeRead 插件
当前版本已经支持:
- 在侧边栏中填写并本地保存
WEREAD_API_KEY - 调用微信读书官方接口同步只读阅读数据
- 展示今日阅读、近 7 天趋势、近 30 天记录
- 展示年度 / 本月 / 总体阅读统计
- 展示书架总量、分类分布、最近阅读书目
- 将同步结果缓存到
chrome.storage.local - 对无效 API Key、超时、网络异常、部分接口失败提供更清晰的提示
当前主流程 不依赖 native helper。
当前数据流:
- 用户在侧边栏输入
WEREAD_API_KEY - 插件直接请求微信读书官方接口
- 归一化后的看板数据保存到本地浏览器存储
- 侧边栏直接渲染本地缓存数据
仓库里保留了早期原型留下的 apps/helper,但它不是当前 WeRead 看板主流程的一部分。
apps/extension:Chrome MV3 扩展(WXT + React)apps/helper:早期 native messaging helper 原型,当前主流程不依赖packages/shared:共享类型、协议、默认状态SMOKE_TEST.md:手工体验/回归检查清单PRIVACY.md:隐私政策基础模板
- macOS(当前主要在 macOS 下验证)
- Google Chrome
- Node.js 20+
- pnpm 11+
pnpm install如果你的终端里没有 pnpm,也可以继续使用当前仓库已经可用的 npm 脚本。
npm run build:shared
npm run build:helper
npm run build:extension
npm run zip:extension
npm run typecheck扩展构建输出目录:
apps/extension/.output/chrome-mv3
扩展 zip 产物目录:
apps/extension/.output/*.zip
cd "/Users/bytedance/Documents/ChatGPT/token优化插件"
npm run build:extension打开:
chrome://extensions
然后:
- 开启 Developer mode
- 点击 Load unpacked
- 选择:
apps/extension/.output/chrome-mv3
点击扩展图标,打开 side panel。
如果你有可用的 WEREAD_API_KEY:
- 粘贴 API Key
- 点击 保存 API Key
- 点击 立即同步
你应该可以看到:
- 今日阅读时长
- 近 7 天趋势
- 近 30 天历史
- 书架总量与分类分布
- 最近阅读书目
即使没有真实 API Key,你也可以验证:
- 首次打开未配置状态
- 保存按钮启用/禁用逻辑
- 错误提示是否清晰
- 空态 / warning / notice 提示样式
- 页面布局与 side panel 交互
- 当前仓库名仍然是
token-optimizer,但仓库内容已经演进为 WeRead 阅读看板插件 - 当前功能只覆盖 WeRead 路径,不是最早讨论的 Claude/Cursor token 诊断插件
- 公开发布前仍建议补齐:
- 真机联调
- 更完整的错误态验证
- 隐私政策占位信息
- 商店素材 / 截图 / 描述
正式发布前,至少建议完成:
- 用真实
WEREAD_API_KEY做一次完整联调 - 跑一遍
SMOKE_TEST.md - 完善
PRIVACY.md中的开发者信息 - 检查 GitHub Actions 与 release 产物是否正常
当前版本设计是 local-first + read-only:
- API Key 保存在本地浏览器存储中
- 阅读数据来自微信读书官方接口
- 数据仅用于本地看板展示和本地缓存
- 当前版本不把你的阅读数据上传到自建服务器
更多说明见:
PRIVACY.md