SupSub CLI

SupSub 的命令行工具，让你在终端里直接管理订阅源、搜索内容、追踪公众号、网站。

📖 完整文档站 —— 快速上手 · 核心概念 · 命令参考 · Agent 集成

---

安装

方式一：native 安装（推荐，macOS / Linux）

curl -fsSL https://raw.githubusercontent.com/SupSub-AI/supsub-cli/master/scripts/install.sh | bash

装到用户目录 ~/.local（永不需要 sudo），版本并存可回滚，并支持后台静默自动更新。安装后若提示 ~/.local/bin 不在 PATH，按提示把它加入 shell 配置即可。

方式二：npm（跨平台，含 Windows）

npm i -g @supsub/cli

支持 macOS / Linux / Windows（x64 / arm64）。npm 安装为手动更新（supsub update 或 npm i -g @supsub/cli@latest），不做后台自动更新。

方式三：让 AI 助手替你装——把下面这句发给 Claude Code / Cursor 等助手，安装、技能包、登录一步到位：

请阅读 https://raw.githubusercontent.com/SupSub-AI/supsub-cli/master/docs/cli-installation-guide.md 并据此帮我安装并配置 SupSub CLI

---

三步开始用

第一步：安装（如上）

第二步：登录

supsub auth login

会自动打开浏览器走 OAuth 设备授权流程完成登录。

第三步：开始用

# 看看自己的订阅源
supsub sub list

# 搜一个公众号订上
supsub mp search "阮一峰"

# 搜全站内容
supsub search "RAG"

---

使用场景

场景 1：订阅一个公众号

# 先搜公众号，拿到 mpId（base64 字符串，例如 MzkyNTYzODk0NQ==）
supsub mp search "阮一峰的网络日志"

# 用 --mp-id 添加订阅（不需要 --type，默认 MP）
supsub sub add --mp-id "MzkyNTYzODk0NQ=="

# 之后想看这个公众号的未读文章，从 sub list 拿到内部 sourceId 即可
supsub sub list --type MP
supsub sub contents --source-id 12345 --type MP

场景 2：搜索内容

# 全量搜索（源 + 文章）
supsub search "AI"

# 仅搜公众号
supsub search "Agent" --type MP

# 仅搜文章正文
supsub search "Claude" --type CONTENT

场景 3：管理订阅

# 列出所有订阅源
supsub sub list

# 仅看已订阅的网站
supsub sub list --type WEBSITE

# 取消订阅
supsub sub remove --source-id 12345 --type MP

---

完整命令参考

认证

supsub auth login                   OAuth 登录（浏览器授权）
supsub auth status                  查看当前登录状态
supsub auth logout                  退出登录（清除本地凭证）

订阅源

supsub sub list                     列出全部订阅源
  --type <MP|WEBSITE>               按类型过滤

supsub sub add                      添加订阅（--source-id 与 --mp-id 二选一）
  --source-id <id>                  内部信息源 ID（正整数，来自 search / sub list）
  --mp-id <mpId>                    公众号 mpId（base64，来自 mp search）
  --type <MP|WEBSITE>               --source-id 模式必填；--mp-id 模式可省，默认 MP
  --group <gid>                     分组 ID（可重复指定）

supsub sub remove                   取消订阅
  --source-id <id>                  必填
  --type <MP|WEBSITE>               必填

supsub sub contents                 查看订阅源内的文章
  --source-id <id>                  必填
  --type <MP|WEBSITE>               必填
  --unread                          仅未读（默认）
  --all                             全部文章（与 --unread 互斥）
  --page <n>                        页码（默认 1）
  --page-size <n>                   每页条数 1-100（默认 20）

supsub sub mark-read                整源标记已读（不可逆，无取消已读命令）
  --source-id <id>                  必填
  --type <MP|WEBSITE>               必填
  --all                             必填，确认整源全部已读（不支持单篇已读）

关注点

supsub focus list                   列出关注点（含 unreadCount）
supsub focus contents               查看关注点内容
  --id <focusId>                    必填
  --unread / --all                  未读（默认）/ 全部，互斥
  --page <n> / --page-size <n>      翻页（默认 1 / 20，page-size 上限 100）

supsub focus mark-read              整个关注点标记已读（不可逆）
  --id <focusId>                    必填
  --all                             必填，确认全部已读（不支持单篇已读）

supsub focus remove --id <focusId>  删除关注点（不可逆，CLI 无新增能力）

订阅分组

supsub group list                   列出分组
supsub group add <name>             创建分组（返回新分组 id）
supsub group rename                 重命名分组
  --id <gid> --name <newName>       均必填

supsub group remove --id <gid>      删除分组（不可逆；组内订阅源不受影响）

supsub group subs                   查看分组订阅源
  --id <gid>                        必填
  --all                             显示全部源（带 inGroup 列；不带则仅组内成员 + unreadCount）
  --type <MP|WEBSITE|X|PODCAST|NEWSLETTER>  按类型过滤

supsub group add-sub                把订阅源加入分组（幂等）
supsub group remove-sub             把订阅源移出分组（幂等，不会退订）
  --id <gid> --source-id <sid> --type <MP|WEBSITE|X>   均必填

分组成员编辑是整体覆盖语义，请勿并发编辑同一分组（包括同时在网页端编辑同一分组）。

未读概览

supsub unread                       订阅源 + 关注点的未读概览（默认只显示有未读的）
  --all                             含无未读的项

搜索

supsub search <keyword>             全量搜索（订阅源 + 文章）
  --type <ALL|MP|WEBSITE|CONTENT>   搜索范围，默认 ALL

精读

supsub deepread run                 对单篇文章做 AI 深度拆解（默认前台等待完成，通常需要几十秒）
  --type <MP|WEBSITE|X>             信息源类型
  --content-id <cid>                内容 ID（来自 sub contents / focus contents / search）
  --title / --source-name / --url   写入本地队列的展示信息（建议总是带上）
  --no-wait                         只发起不等待（批量排队时用）
  --timeout <sec>                   等待上限，默认 180
  --brief                           精简输出，省略正文部分
supsub deepread get                 查看精读结果（优先本地缓存，--refresh 强制回源，--out 导出 Markdown）
supsub deepread list                本地精读队列（--wait 等全部落定，--all 看全部历史）
supsub deepread quota               本月精读额度余额
supsub deepread share               生成分享链接（公开可访问、暂不可撤销）
supsub deepread show --share-code   查看他人分享的精读（无需登录）
supsub deepread drop                从本地队列移除（不影响服务端结果）

精读按次消耗月度额度，且没有退额度的操作 —— agent 集成务必在发起前 先 deepread quota 查询余额并与用户确认。已精读过的文章重复 run 不会重复扣费。

每篇精读会在 ~/.supsub/deepread/ 下保存本地副本（含可直接阅读的 Markdown）； 队列是本机本地的，与网页端的「稍后阅读」互不可见。

公众号

supsub mp search <name>             搜索公众号（异步，自动等待最长约 30s）
supsub mp search-cancel <searchId>  取消正在执行的搜索任务

This is the beginning of the README. Read the rest at the original. Read the full README ↗