Feed me

nom is a terminal based RRS feed reader using Glow styled markdown to improve the reading experience and a simple TUI using Bubbletea.

• Local sync and offline reading
• Backend connections (miniflux, freshrss supported)
• Vim style keybindings for navigation
• Plenty more features such as mark read/unread, filtering and feed naming

See releases for binaries. E.g.

curl -L https://github.com/guyfedwards/nom/releases/download/v2.16.2/nom_2.16.2_darwin_amd64.tar.gz | tar -xzvf -

To install the nom binary into /usr/local/bin (or into the location of your choice) in a single step:

curl -L https://github.com/guyfedwards/nom/releases/download/v2.16.2/nom_2.16.2_darwin_amd64.tar.gz |
  sudo tar -C /usr/local/bin -xvzf - nom

nom # start TUI
nom add <feed_url> <optional feed_name>
nom -h # see all available command and options

Configuration lives by default in $XDG_CONFIG_HOME/nom/config.yml or $HOME/Library/Application Support/nom/config.yml on darwin. You can customise the location of the configuration file with the --config-path (-c) flag:

nom -c my-custom-config.yml

Feeds are added to the configuration file and have a url and an optional name:

feeds:
- url: https://dropbox.tech/feed
  # name will be prefixed to all entries in the list
  name: dropbox
- url: https://snyk.io/blog/feed

You can also add feeds with the add command:

nom add <url> <optional feed_name>

Feeds are editable within nom by pressing E to open the configuration in your editor. You can configure which editor Nom will use by setting (in order of preference) your $NOMEDITOR, $VISUAL, or $EDITOR environment variable. After editing feeds, you will need to then refresh with r.

Alternatively you can import feeds from an OPML file:

nom import <path/to/opml|url/to/opm;

To add YouTube feeds you can go to a channel and run the following in the browser console to get the rss feed link:

console.log(
  `https://www.youtube.com/feeds/videos.xml?channel_id=${
    document.querySelector("link[rel='canonical']").href.split("/channel/")
      .reverse()[0]
  }`,
);

Show read items by default. (can be toggled with M)

showread: true

Automatically mark items as read on selection or navigation through items.

autoread: true

Set the default sort ordering of the list

ordering: asc

Default to include the feedname prefix in filtering query. Removes need to use f:xxx for simple queries. This will mean that multi-feed filters won't work, e.g. f:xxx f:yyy

filtering:
  defaultIncludeFeedName: true

Background refresh interval in minutes. Setting this to anything but 0 will make nom refresh automatically.

refreshinterval: 5

Theme allows some basic color overrides in the feed view and then setting a custom markdown render theme for the overall markdown view. theme.glamour can be one of "dark", "dracula", "light", "pink", "ascii" or "notty". See here for previews and more info. Colors can be hex or ASCII codes, they will be coerced depending on your terminal color settings.

theme:
  glamour: dark
  titleColor: "62"
  titleColorFg: "231"
  selectedItemColor: "170"
  filterColor: "#555555"

As well as adding feeds directly, you can pull in feeds from another source. You can add multiple backends and the feeds will all be added.

backends:
  miniflux:
    host: http://myminiflux.foo
    api_key: jafksdljfladjfk
  freshrss:
    host: http://myfreshrss.bar
    user: admin
    password: muchstrong
    prefixCats: true # prefix feed name for freshrss entries

To use freshrss you need to enable API access and set the API password explicitly, separate to your user password.

1. To enable the API go to Settings > Authentication > Allow API access.
2. You can set the API password in Settings > Profile > API password.

By default links are opened in the browser, you can specify commands to open certain links based on a regex string.
regex can be any valid golang regex string, it will be matched against the feed item link.
cmd is run as a child command. The %s denotes the position of the link in the command.
takeover dictates if the command should takeover the tty from nom. E.g. for opening links in lynx or other TUI.

openers:
- regex: "youtube"
  cmd: "mpv %s"
- regex: ".*"
  cmd: "lynx %s"
  takeover: true

If you need to use a proxy server for internet access, you can configure nom by setting the environment variables HTTP_PROXY and HTTPS_PROXY to point to your proxy server:

export HTTP_PROXY=https://proxy.example.com
export HTTPS_PROXY=https://proxy.example.com
nom

From the ProxyFromEnvironment documentation:

[Use a proxy] as indicated by the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY.

The environment values may be either a complete URL or a "host[:port]", in which case the "http" scheme is assumed.

Nom uses sqlite as a store for feeds and metadata. It is stored adjacent to the configuration file in $XDG_CONFIG_HOME/nom/nom.db. This can be backed up like any file and will store articles, read state etc. It can also be deleted to start from scratch, re-downloading all articles and no state.

The name of the sqlite file can be overridden in the configuration file, allowing you to have multiple configurations each with their own data store.

database: news.db

Within the nom view, you can filter by title pressing the / character. Filters can be applied easily. Here's some examples:

• f:my_feed feed:my_second_feed - matches my_feed and my_second_feed
• feedname:"my feed - with spaces" - matches my feed - with spaces
• feed:'my feed, with single quotes!' - matches my feed, with single quotes!
• feed:my\ feed\ with\ escaped\ spaces! - matches my feed with escaped spaces!

If you want to include the feed name in the default filtering query, use config.filtering.defaultIncludeFeedName: true. This simplifies the above f:xxx queries but means that you can't filter by multiple feeds at once, e.g. f:xxx f:yyy.

Build nom image

docker build -t nom .

This embeds the local `docker-config.yml`` file into the container and will be used by default.

Running Nom via docker

docker run --rm -it nom

Use the -v command line argument to mount a local configuration onto /app/docker-config.yml as desired:

docker run --rm -it -v $PWD/my-nom-config.yml:/app/docker-config.yml nom

You can use backends-compose.yml to spin up a local instance of MiniFlux and FreshRSS if needed for development.

docker-compose -f backends-compose.yml up -d