clacks

README

clacks

A Terminal Based Atom/RSS Reader that reads a list of feeds from a json file and displays them, once selected a feed entry can be opened in the browser.

Demo

Config

Json file called feeds.json in the same directory with the following format:

{
  "feeds": [
    {
      "url": "https://www.theregister.com/offbeat/bofh/headlines.atom"
    },
    {
      "url": "https://barryodriscoll.net/feed/atom/"
    },
    {
      "url": "https://boingboing.net/feed/atom"
    },
    {
      "url": "https://lifehacker.com/rss"
    }
  ]
}

Instructions

• Add feeds name/url to feeds.json.
• Navigate lists using arrow keys.
• Hit enter/esc to select and deselect list items.
• Hit enter on an entry to open in default system browser.
• Use menu shortcuts to perform related tasks.
• Ctrl-C to quit.

Dependiences

• gofeed - feed parser
• tview - terminal ui library
• html-strip-tags-go - strips html tags
• gox - utility library used to open browser cross platform manner

Credits

• The tview postgres example.
• The tview presentation demo.
• This stackoverflow answer on how to open a browser in go and escape urls on windows by icza.
• The project gdu provided a great example on how to unit test code that calls the tview library with stubs.
• Terry Pratchett for the name clacks.

Alternatives

• GORSS is a terminal atom/rss reader also written in go that is built directly on tcell, the library tview is built on.