Skip to content

About

WatchRSS CLI: agent-friendly, end-to-end encrypted cloud library client

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

Repository files navigation

WatchRSS CLI

WatchRSS CLI 管理订阅、收藏、稍后看、阅读进度和导入的电子书。它需要 Node.js 22 或更高版本。运行时无需安装 npm 依赖。

开始使用

从项目根目录运行以下命令查看帮助。

node bin/watchrss.cjs --help

也可以在本机安装 watchrss 命令。

npm install --global .
watchrss --help

联网前,请向服务维护者获取兼容的 WatchRSS HTTPS 后端地址和该后端的公开 Supabase anon key。示例域名和键值是占位符。

watchrss config --url https://watchrss.example.invalid --anon-key YOUR_PUBLIC_ANON_KEY
watchrss --login
watchrss keys recover
watchrss status

WATCHRSS_URL 和 WATCHRSS_ANON_KEY 优先于本地配置。请为不同后端设置独立的 WATCHRSS_HOME。联网命令要求后端支持 CLI 登录、设备授权和云同步,账号还须满足服务端会员要求。

在终端输入手机号和后端要求的验证因素。密码、验证码和恢复词由交互提示读取。恢复已有加密资料库时,请输入原有恢复词。首次建钥和轮换密钥须在已授权的手机或小程序上完成。

常用命令

watchrss sources list
watchrss sources add https://example.org/feed.xml
watchrss articles list --favorite --limit 50
watchrss articles get ARTICLE_ID --page 0
watchrss import ./book.epub
watchrss books list
watchrss sync
watchrss export ./library.json
watchrss logout
  • hybrid 是默认模式。它保留本地缓存,允许用 --offline 读取已有缓存。
  • cloud 按需读取云端正文。用 watchrss mode cloud 设置该模式。
  • export 保存当前本地资料视图。导出文件可以包含已缓存正文。
  • Sync v2 默认关闭。启用时还须收到服务端公告。CLI 从服务端恢复胶囊接收已建立的仓库身份。

命令默认输出单行 JSON。成功返回退出码 0。失败返回退出码 1,并在 error.code 中给出错误码。读取正文时,从第 0 页开始,逐页请求至 eof 为 true。

默认数据目录是 $XDG_DATA_HOME/watchrss。未设置 XDG_DATA_HOME 时,使用 ~/.local/share/watchrss。请保护该目录中的凭据、密钥和缓存,并将该目录留在源码仓库外。

开发

npm run ci:check

测试使用合成数据和本机模拟服务。构建命令检查 JavaScript 语法。

许可证

WatchRSS CLI 使用 GPL-3.0-only。第三方许可声明见 fflate、noble 组件和 WHATWG 编码数据。

About

WatchRSS CLI: agent-friendly, end-to-end encrypted cloud library client

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages