https://github.com/trevarj/frdr
RSS/Atom Reader using fzf
https://github.com/trevarj/frdr
atom-feed fzf rss-aggregator rss-feed rss-reader
Last synced: 9 months ago
JSON representation
RSS/Atom Reader using fzf
- Host: GitHub
- URL: https://github.com/trevarj/frdr
- Owner: trevarj
- License: bsd-2-clause
- Created: 2024-04-23T20:44:26.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T16:53:51.000Z (about 2 years ago)
- Last Synced: 2025-03-16T17:22:23.567Z (over 1 year ago)
- Topics: atom-feed, fzf, rss-aggregator, rss-feed, rss-reader
- Language: Shell
- Homepage:
- Size: 76.2 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Feed Reader (frdr)
A terminal RSS reader which utilizes popular *nix tools
[](https://asciinema.org/a/656386)
## Requirements
- [fzf](https://github.com/junegunn/fzf) - Fuzzy-finder and previewer (UI)
- [jq](https://github.com/jqlang/jq) - JSON parsing
- [rss2json](https://github.com/trevarj/rss2json) - Converts RSS XML to JSON
## Config
A bash env file placed in `~/.config/frdr/config.bash` which contains a bash
array of RSS feeds.
Please see [the sample config](./sample.config.bash) for a full example.
```sh
FEEDS=(
# "Alias URL"
"trev https://trevarj.github.io/rss.xml"
# "trev_local /tmp/rss.xml"
)
FRDR_PAGER="lynx -stdin" # Pager that is used when pressing 'enter' on a post
FRDR_PREVIEWER="lynx -dump -stdin" # Pager used in the preview pane when hovering a post
```
## Usage
Simply run:
```sh
frdr
```
### Default Controls
All controls except enter are able to be overridden.
| Key | Description
| --- | ---
| enter | Open post in `$PAGER`
| ctrl-r | Refresh all feeds
| ctrl-y | Mark post as read
| ctrl-u | Mark post as unread
| esc | Show unread posts
| ctrl-h | Show read (hidden) posts
| ctrl-o | xdg-open URL to post