#rss-reader #rss #tui #config-file #miniflux

app cliflux

Miniflux RSS 阅读器的终端 UI 客户端

13 个稳定版本

1.4.4 2024 年 7 月 23 日
1.4.3 2024 年 5 月 5 日
1.4.2 2024 年 4 月 5 日
1.4.1 2024 年 1 月 26 日
1.1.0 2023 年 2 月 28 日

#3 in #rss-reader

Download history 145/week @ 2024-05-04 6/week @ 2024-05-11 6/week @ 2024-05-18 1/week @ 2024-05-25 40/week @ 2024-06-29 107/week @ 2024-07-20 146/week @ 2024-07-27 5/week @ 2024-08-03

258 每月下载量

MIT 许可证

425KB
1.5K SLoC

cliflux

cliflux 是 Miniflux 自托管 RSS 阅读器的终端 UI 客户端。

有许多优秀的 TUI/CLI RSS 阅读器应用程序,但当我寻找时,我没有找到使用 Miniflux 作为其源、已读/未读跟踪和“保存”条目来源的应用程序。

所以我创建了一个!这就是它的作用。

截图

A screenshot of cliflux showing the "unread entries" list

A screenshot of cliflux showing the "read entry" view

安装

由于此包是用 Rust 编写的,因此如果您已安装 Rust,只需运行 cargo install cliflux 即可安装它。

否则,从 发布页面 下载适合您操作系统的构建版本。

初始设置

您需要为 cliflux 提供两个关键配置项,在您的操作系统标准应用程序配置文件目录中的名为 config.toml 的 TOML 文件中,这将位于...

Linux MacOS Windows
$XDG_CONFIG_DIR/cliflux/ $HOME/Library/ApplicationSupport/com.spencerwi.cliflux/ %APPDATA%\Roaming\com\spencerwi\cliflux\

(如果您使用的是其他操作系统,并且您有关于配置文件放置位置的建议,请打开一个 PR 或 Github 问题!)

该 TOML 文件应如下所示

server_url = "your-miniflux-server-url-here-including-port"
api_key = "your-miniflux-api-key-here"
allow_invalid_certs = "false"

您可以通过运行 cliflux --init 来创建一个默认配置文件,这将还会告诉您配置文件应该放在哪里。

要为您的 Miniflux 账户生成 API 密钥,请登录到您的服务器上的 Miniflux 账户,然后转到“设置”>“API 密钥”>“创建新的 API 密钥”

用法

一旦您放置了配置文件,只需运行 cliflux,您将看到从您的 Miniflux 服务器检索的条目列表。上/下箭头(或像我这样的 vim 违约者使用的 k/j)可以在这个列表中导航,m 切换文章的已读/未读状态,r 刷新列表视图,而“enter”键打开一篇文章进行阅读,此时它将被标记为已读。

在阅读文章时,u会将它标记为未读,上下箭头(或者,再次强调,k/j)用于向上/向下滚动,"PageUp"和"PageDown"可以更快地滚动,o将在您的浏览器中打开文章,而b将返回主列表视图。

如果这一切看起来太多难以记住,您可以在任何时候按下?并获取一个如下的键盘参考屏幕

A screenshot of cliflux showing the keyboard reference screen

许可证

本软件根据MIT许可证提供。请参阅LICENSE.md

依赖项

~16–31MB
~486K SLoC