A simple rss reader for neovim.

nvim-rss aims to be similar to the excellent vnews and, if you squint hard enough while looking sideways, then perhaps elfeed.

Ideally, if you have a bunch of feeds and simply wish to view the latest entries in neovim instead of browsers or dedicated apps, then this plugin should help you out.

1. neovim (0.10+)
2. curl | Usually pre-installed on most systems

-- In your package manager init
{ "p-tupe/nvim-rss" }

-- Then call setup; Default values (all are optional)
require("nvim-rss").setup({
  feeds_dir = "~",       -- Directory for nvim.rss file
  star_updated = true,   -- Show * for updated feeds
  log_level = "info",    -- "error" | "info" | "debug"
})

Note: Feed data is cached in <feeds_dir>/.nvim-rss-cache/ as raw XML files.

• Install and setup nvim-rss
• Exec :lua require("nvim-rss").open_feeds_tab()
• Add a feed url to nvim.rss file (eg https://priteshtupe.com/rss.xml)
• Ensure your cursor is still on the url and exec :lua require("nvim-rss").fetch_feed()
• Profit!

By default, no mappings/commands present. All functions are exposed so you may use them as you like!

• Open RSS file: open_feeds_tab()

  Opens nvim.rss file where all the feeds are listed. By default ~/nvim.rss, see Setup to change default dir.

• Fetch and view a feed: fetch_feed()

  Pulls updates for the feed under cursor, caches it, and opens a vertical split to show the entries. Shows * indicator if the feed has changed since last fetch.

• Fetch feeds by category: fetch_feeds_by_category()

  Pulls update for all feeds in the category (paragraph) under cursor.

• Fetch feeds by visual range: fetch_selected_feeds()

  Pulls update for all feeds that are selected in visual range.

• Fetch all feeds: fetch_all_feeds()

  Fetches data for all feeds in nvim.rss and marks changed feeds with * indicator.

• View a feed: view_feed()

  Opens entries for feed under cursor in a vertical split. This does not fetch data from server, instead reading from cached XML files.

• Clean a feed: clean_feed()

  Removes cached data for a particular feed. Useful to force a fresh fetch.

• Reset everything: clean_all_feeds()

  Clears all cached feeds.

• Import OPML file: import_opml(opml_file)

  Parses the supplied file, extracts feed links if they exist and dumps them under "OPML Import" inside nvim.rss. They are not cached unless you explicitly fetch feeds for the links!

• Export OPML file: export_opml(opml_file)

  Exports all feeds from nvim.rss to an OPML file. Useful for backing up your feeds or importing them into other RSS readers.

To use above functions, write the usual mapping or command syntax. Example -

vim.cmd [[

  command! OpenRssView lua require("nvim-rss").open_feeds_tab()

  command! FetchFeed lua require("nvim-rss").fetch_feed()

  command! FetchAllFeeds lua require("nvim-rss").fetch_all_feeds()

  command! FetchFeedsByCategory lua require("nvim-rss").fetch_feeds_by_category()

  command! -range FetchSelectedFeeds lua require("nvim-rss").fetch_selected_feeds()

  command! ViewFeed lua require("nvim-rss").view_feed()

  command! CleanFeed lua require("nvim-rss").clean_feed()

  command! CleanAllFeeds lua require("nvim-rss").clean_all_feeds()

  command! -nargs=1 ImportOpml lua require("nvim-rss").import_opml(<args>)

  command! -nargs=1 ExportOpml lua require("nvim-rss").export_opml(<args>)

]]

NOTE: The ImportOpml and ExportOpml commands require a full path and surrounding quotes.

:ImportOpml "/home/user/Documents/rss-file.opml"
:ExportOpml "/home/user/Documents/my-feeds.opml"

Checkout a sample feeds list here

Add this autocmd to automatically fetch all feeds when you open your nvim.rss file:

vim.api.nvim_create_autocmd("BufRead", {
  pattern = "*/nvim.rss",
  callback = function()
    require("nvim-rss").fetch_all_feeds()
  end,
})