weread

WeRead CLI

微信读书命令行客户端 — 搜索书籍、管理书架、查看笔记划线、浏览书评、阅读统计、发现推荐好书。

安装

前置条件

1. 扫码登录微信读书账号
2. 访问 WeRead API Key 管理页面 创建 API Key，记录生成的 wrk-xxxxxxxx 字符串。

AI Agent 安装

将以下 prompt 发送给任意 AI Agent（Claude Code、Cursor、Windsurf 等），即可自动完成安装：

从 GitHub 仓库 ipfans/weread-cli 的 release 页面下载最新版本的二进制文件，根据当前系统的 OS 和架构选择正确的压缩包，解压后将 weread-cli 安装到系统 PATH 中（如 /usr/local/bin 或 ~/.local/bin）。然后询问我的 API Key，将其写入 weread-cli 二进制所在目录的 weread.env 文件中，格式为 WEREAD_API_KEY=<key>。

二进制安装

前往 Releases 页面，下载适合你系统的压缩包，解压后将 weread-cli 可执行文件添加到系统 PATH。

源码安装

go install github.com/ipfans/weread-cli@latest

或者

go run github.com/ipfans/weread-cli@latest

或从源码编译：

git clone https://github.com/ipfans/weread-cli.git
cd weread-cli
go build -o weread-cli .

配置

WeRead CLI 需要微信读书 API Key 进行认证，按以下优先级读取：

1. --api-key 命令行参数
2. WEREAD_API_KEY 环境变量
3. 当前目录下的 .env 文件
4. weread-cli 二进制所在目录的 weread.env 文件

# 方式一：环境变量
export WEREAD_API_KEY=wrk-xxxxxxxx

# 方式二：weread.env 文件（推荐，写入 weread-cli 所在目录）
echo "WEREAD_API_KEY=wrk-xxxxxxxx" > $(dirname $(which weread-cli))/weread.env

# 方式三：.env 文件（当前目录）
cp .env.example .env
# 编辑 .env 填入你的 API Key

Skills

本项目内置 Claude Code 插件，安装后可在 Claude Code 中直接使用微信读书功能（搜索书籍、查看书架、笔记划线、阅读统计等）。

其他 AI Agent 采用其他方式安装。

从 Marketplace 安装

在 Claude Code 中执行：

/plugin marketplace add ipfans/weread-cli
/plugin install weread

本地开发安装

git clone https://github.com/ipfans/weread-cli.git
claude --plugin-dir ./weread-cli

可用技能

安装插件后，可在 Claude Code 中使用以下斜杠命令：

命令	说明	示例
/weread:search	搜索书籍	/weread:search 三体
/weread:shelf	查看书架	/weread:shelf
/weread:notes	查看笔记划线	/weread:notes marks <book-id>
/weread:readdata	阅读统计	/weread:readdata weekly
/weread:discover	发现推荐	/weread:discover recommend

也可直接用自然语言对话，插件会自动识别微信读书相关请求。

使用

全局参数

参数	说明
--json	以 JSON 格式输出（适合配合 jq 使用）
--api-key	指定 API Key

搜索书籍

# 搜索关键词
weread search --keyword "三体"

# 指定搜索范围（10=电子书）
weread search --keyword "三体" --scope 10

# 分页
weread search --keyword "三体" --count 5 --max-idx 5

书籍信息

# 查看书籍详情
weread book info --book-id 123456

# 查看章节目录
weread book chapters --book-id 123456

# 查看阅读进度
weread book progress --book-id 123456

书架

# 查看书架列表
weread shelf

笔记

# 查看有笔记的书籍列表
weread notes list

# 分页查看
weread notes list --count 50

# 查看某本书的划线
weread notes marks --book-id 123456

# 查看某本书的想法
weread notes thoughts --book-id 123456

书评

# 查看书评
weread review --book-id 123456

# 按类型筛选（1=推荐, 2=差评, 3=最新, 4=一般）
weread review --book-id 123456 --type 1

阅读统计

# 本月阅读数据（默认）
weread readdata

# 本周 / 今年 / 总计
weread readdata --mode weekly
weread readdata --mode annually
weread readdata --mode overall

发现推荐

# 个性化推荐
weread discover recommend

# 相似书推荐
weread discover similar --book-id 123456

JSON 输出与 jq 组合

所有命令都支持 --json 参数输出原始 JSON，可配合 jq 进行数据处理：

# 搜索并提取所有 bookId
weread search --keyword "三体" --json | jq '.results[].books[].bookInfo.bookId'

# 获取书架中已读完的书
weread shelf --json | jq '[.books[] | select(.finishReading == 1)] | length'

# 获取阅读统计中的总阅读时长（秒）
weread readdata --json | jq '.totalReadTime'

# 获取笔记最多的前 5 本书
weread notes list --count 100 --json | jq '[.books[] | {title: .book.title, total: (.reviewCount + .noteCount + .bookmarkCount)}] | sort_by(-.total) | .[:5]'

# 导出某本书所有划线文本
weread notes marks --book-id 123456 --json | jq '.updated[].markText'

开发

需要 Task 管理构建任务：

# 查看所有可用任务
task

# 编译
task build

# 运行测试
task test

# 测试覆盖率
task test:cover

# 代码格式化
task fmt

# 清理构建产物
task clean

输出格式

• 表格模式（默认）：使用 text/tabwriter 对齐输出，适合终端阅读
• JSON 模式（--json）：输出格式化的 JSON，适合脚本处理和 jq 管道

许可证

MIT