# GORSS

> Terminal RSS/Atom feed reader written in Go with SQLite storage, OPML import, configurable keybindings, custom commands and 8 built-in themes.

Stars: 463 · Language: Go · License: MIT · Categories: Productivity

- Repository: https://github.com/Lallassu/gorss
- Page: https://www.trmn.sh/tools/gorss

## Install

- Build from source: `make run`

## Overview

GORSS is a terminal RSS and Atom reader written in Go. It uses github.com/mmcdole/gofeed for parsing and stores articles and read state in a SQLite database, which is created automatically in the system's data home directory (override with `-db`). The interface has separate feed, article and preview panes. You switch between them with Tab or the number keys 1, 2 and 3.

Feeds are defined in a JSON configuration file, either as plain URL strings or as objects with `url` and `name` fields. They can also be loaded from an OPML file with `opmlFile`. Configuration and theme files are looked up under `$XDG_CONFIG_HOME/gorss/` and are created from defaults if missing. You can also pass `-config`, `-theme` and `-db` explicitly. The config sets pane size ratios, update interval, the age at which old articles are skipped, and how long read or deleted articles stay in the database. It can also switch system notifications on or off.

Reading features include highlighting of configurable words, title search with `/`, sorting by date, unread state, title or feed, and marking articles read or unread (per article, per feed or globally). Undo of the last read mark is supported. You can open an article's link in the browser, or mark several articles and open them all at once. Every key binding is configurable. Custom commands can be bound to keys and run external programs, with `ARTICLE.Content`, `ARTICLE.Link`, `ARTICLE.Feed` and `ARTICLE.Title` substituted into the command. The README warns that no escaping is done.

There are 8 built-in themes embedded in the binary: default, irssi, night, dracula, nord, gruvbox, monokai and tokyo-night. Press `T` to cycle through them at runtime. Custom themes are JSON files with hex colors and configurable icons and markers. Prebuilt tarballs exist for Linux and macOS. The tool suits developers and terminal users who want a keyboard-driven, scriptable feed reader.

### Installation

```bash
# via Build from source
make run
```

![GORSS in action](https://media.trmn.sh/cached/36811cb0df0d85a9866b61092a7b2b217069ac587b60d7f728a9f6b8bca360d5.gif)

![GORSS default theme](https://media.trmn.sh/cached/1d9b1e5b46c67304e6a75b0b63ef665bf785a0c5f99adc533e2debf4bcc7ffbf.png)

![GORSS irssi theme](https://media.trmn.sh/cached/198f29efdafe1f33edcf74f2fe9dddca520045efa2914f4e44b755342fb0bba9.png)

## Alternatives

- [goread](https://www.trmn.sh/tools/goread.md): Terminal RSS/Atom feed reader with a Bubble Tea TUI, feed categories, offline mode, OPML support, and customizable colorschemes. (Go, 490 stars)
- [omm](https://www.trmn.sh/tools/omm.md): Keyboard-driven task manager for the command line with priority reordering and context management (Go, 334 stars)
- [nom](https://www.trmn.sh/tools/nom.md): Terminal RSS feed reader with a Bubbletea TUI, Glamour-rendered markdown articles, offline sqlite storage, Miniflux and FreshRSS backends, and Vim keybindings. (Go, 758 stars)
- [tz](https://www.trmn.sh/tools/tz.md): Interactive TUI tool for displaying and comparing times across multiple time zones simultaneously (Go, 904 stars)
- [circumflex](https://www.trmn.sh/tools/circumflex.md): Terminal-based Hacker News browser with vim-style navigation and built-in article reader (Go, 2.1k stars)

## Guides

- [Best terminal RSS readers](https://www.trmn.sh/best/terminal-rss-readers): Compare newsboat, eilmeldung and nom, plus goread, GORSS, bulletty and russ, for reading RSS and Atom feeds in the terminal.

---

Canonical: https://www.trmn.sh/tools/gorss
