<- Back

# Sfeed: simple RSS and Atom parser

Last modification on 2022-11-05

Sfeed is a RSS and Atom parser (and some format programs).

It converts RSS or Atom feeds from XML to a TAB-separated file. There are
formatting programs included to convert this TAB-separated format to various
other formats. There are also some programs and scripts included to import and
export OPML and to fetch, filter, merge and order feed items.
For the most (up-to-date) information see the »README«.

## Clone

        git clone git://git.codemadness.org/sfeed


## Browse

You can browse the source-code at:
* https://git.codemadness.org/sfeed/
* gopher://codemadness.org/1/git/sfeed

## Download releases

Releases are available at:
* https://codemadness.org/releases/sfeed/
* gopher://codemadness.org/1/releases/sfeed

## Build and install

        $ make
        # make install


## Screenshot and examples
The above screenshot uses the sfeed_plain format program with »dmenu«.  This
program outputs the feed items in a compact way per line as plain-text to
stdout.  The dmenu program reads these lines from stdin and displays them as a
X11 list menu. When an item is selected in dmenu it prints this item to stdout.
A simple written script can then filter for the URL in this output and do some
action, like opening it in some browser or open a podcast in your music player.

For example:

        #!/bin/sh
        url=$(sfeed_plain "$HOME/.sfeed/feeds/"* | dmenu -l 35 -i | \
                sed -n 's@^.* \([a-zA-Z]*://\)\(.*\)$@\1\2@p')
        test -n "${url}" && $BROWSER "${url}"

However this is just one way to format and interact with feed items.
See also the README for other practical examples.

Below are some examples of output that are supported by the included format
programs:
* plain text (UTF-8)
* atom
* gopher
* HTML (CSS)
* HTML frames
* JSON Feed
* mbox
* twtxt
There is also a curses UI front-end, see the page »sfeed_curses«.
It is now part of sfeed.


## Videos

Here are some videos of other people showcasing some of the functionalities of
sfeed, sfeed_plain and sfeed_curses.  To the creators: thanks for making these!
* sfeed: RSS/Atom Feeds without the Suck (Youtube)  
  by »noocsharp«
  (mirror)  
  Video published on March 8 2020.
* Sfeed - news in the terminal with minimalism (Youtube)  
  by »Gavin Freeborn«
  (mirror)  
  Video published on January 15 2021.
* Sfeed - Peak Minimal RSS Feed Reader (Youtube)  
  by »Brodie Robertson«
  (mirror)  
  Video published on February 23 2021.
* RSS with sfeed, fdm, and mblaze! (Youtube)  
  by »Joseph Choe«
  (mirror)  
  Website: »https://josephchoe.com/rss-terminal«  
  Video published on 4 November 2022.