# goread

> Terminal RSS/Atom feed reader with a Bubble Tea TUI, feed categories, offline mode, OPML support, and customizable colorschemes.

Stars: 490 · Language: Go · License: GPL-3.0 · Categories: Productivity

- Repository: https://github.com/TypicalAM/goread
- Page: https://www.trmn.sh/tools/goread

## Install

- Homebrew: `brew install goread`
- Go: `go install github.com/TypicalAM/goread@latest`
- AUR: `yay -S goread`

## Overview

goread is an RSS/Atom feed reader that runs in the terminal. You organize feeds into categories, follow them, and read articles directly in the command line. The interface is a TUI built on bubble tea, with lipgloss for styling, cobra for flags, and gofeed for parsing feeds.

Beyond reading, goread can download articles for later use and has an offline mode. It supports OPML files. Subscriptions are stored in a YAML urls file (usually ~/.config/goread/urls.yml) that holds categories, feed names, descriptions, and URLs. Feeds can have blacklist_words and whitelist_words to filter entries. You can edit this file with `goread edit urls` or from inside the TUI.

Appearance and input are configurable. The colorscheme lives in ~/.config/goread/colorscheme.json and can be written by hand or generated with the `--dump_colors` flag. The `--get_colors` flag builds a colorscheme from a pywal colors.json file. Custom keybindings go in goread.yml, which `goread edit config` opens in your $EDITOR. It suits terminal users who want to manage feeds without a browser or GUI reader.

### Installation

```bash
# via Homebrew
brew install goread
```

```bash
# via Go
go install github.com/TypicalAM/goread@latest
```

```bash
# via AUR
yay -S goread
```

![goread basic usage](https://media.trmn.sh/cached/98b4f520134e01937ca5187521caa820d35f4fa7f984910c773e1ec1fc405032.gif)

![goread with a pywal colorscheme](https://media.trmn.sh/cached/f28e8f1727f70094b80ede449144b1f58ed03df7f699c85935d4c545a455a3a1.gif)

## Alternatives

- [GORSS](https://www.trmn.sh/tools/gorss.md): Terminal RSS/Atom feed reader written in Go with SQLite storage, OPML import, configurable keybindings, custom commands and 8 built-in themes. (Go, 463 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/goread
