#tui #terminal-ui #rss #cli #miniflux

app cliflux

A terminal-ui (TUI) client for the Miniflux RSS reader

10 stable releases

1.4.1 Jan 26, 2024
1.3.3 Jun 17, 2023
1.3.2 Apr 5, 2023
1.3.1 Mar 30, 2023
1.1.0 Feb 28, 2023

#266 in Command-line interface

Download history 10/week @ 2023-10-29 8/week @ 2023-11-05 2/week @ 2023-11-12 1/week @ 2023-11-19 26/week @ 2023-11-26 16/week @ 2023-12-03 1/week @ 2023-12-10 8/week @ 2023-12-17 17/week @ 2023-12-24 8/week @ 2023-12-31 1/week @ 2024-01-07 1/week @ 2024-01-14 57/week @ 2024-01-21 42/week @ 2024-01-28 2/week @ 2024-02-04 43/week @ 2024-02-11

144 downloads per month

MIT license

425KB
1.5K SLoC

cliflux

cliflux is a terminal-ui client for the Miniflux self-hosted RSS reader.

There are many good TUI/CLI RSS reader apps, but when I went looking, I couldn't find one that used Miniflux as its source for feeds, read/unread tracking, and "saved" feed entries.

So I built one! And that's what this is.

Screenshots

A screenshot of cliflux showing the "unread entries" list

A screenshot of cliflux showing the "read entry" view

Installation

This package is built in Rust, so if you have that installed, you should be able to just run cargo install cliflux to install it.

Otherwise, grab a build for your OS from the Releases page.

Initial setup

You'll need to supply cliflux with two key pieces of configuration, in a TOML file called config.toml in your OS's standard application-configuration-files directory, which would be....

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

(If you're on another OS and you have suggestions on where to put the config file, please open a PR or a Github issue!)

That TOML file should look like this:

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

You can stub out a default config file by running cliflux --init, which will also tell you where the config file should live.

To generate an API key for your Miniflux account, log into your Miniflux account on your server and go to "Settings" > "API Keys" > "Create a new API key"

Usage

Once you've got your config file in place, just run cliflux and you'll see a list of feed entries fetched from your Miniflux server. Up/down arrows (or k/j for vim delinquents like me) navigate this list, m toggles the read/unread state of the article, r refreshes the list view, and "enter" opens an article for reading, at which point it'll be marked as read.

While reading an article, u will mark it as unread, up/down arrows (or, again, k/j) will scroll up/down, "PageUp" and "PageDown" will scroll faster, o will open the article in your browser, and b will go back to the main list view.

If all that seems like a lot to remember, you can hit ? at any time and get a keyboard reference screen like this:

A screenshot of cliflux showing the keyboard reference screen

License

This software is provided under the MIT License. See LICENSE.md.

Dependencies

~13–29MB
~455K SLoC