sreader

command module
v0.0.0-...-bcf2fa8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2025 License: MIT Imports: 6 Imported by: 0

README

sreader: A TUI Atom and RSS Feed Reader

CI Status. Dependabot Active

Installation

Linux
go install github.com/bmoneill/sreader@latest
$GOPATH/bin/sreader

Usage

sreader [-c configfile] [-s]
  • -c: Set configuration file
  • -s: Sync feeds

Features

Keybindings

sreader uses Vim-like keybindings by default.

  • h: Go back
  • j: Select next item
  • k: Select previous item
  • l: Open selected item
  • /: Filter list items
  • o: Open selected list entry in web browser
  • v: Open selected list entry in video player
  • r: Refresh feeds
  • q: Quit

Configuration

sreader can load settings, including feed URLs, colors, keybindings, and paths through a configuration file. See config_example.toml for an example.

The example configuration file contains all the default values, besides the URL list. After installing, you can run sreader to generate a configuration file and then add your feed URLs. Colors must be in hex format.

sreader will also use $BROWSER and $PLAYER environment variables if not overridden by your configuration file.

If $XDG_CONFIG_HOME is set, sreader will load config files at $XDG_CONFIG_HOME/sreader/sreader.toml by default.

If $XDG_DATA_HOME is set (and these paths are not overridden in your configuration file), sreader will default to the following paths:

  • DBFile: $XDG_DATA_HOME/sreader/sreader.db
  • LogFile: $XDG_DATA_HOME/sreader/sreader.log
  • TmpDir: $XDG_DATA_HOME/sreader

Screenshots

Index view

index

Feed view

feedview

Entry view

entryview

Bugs

If you find a bug, submit an issue, PR, or email me with a description and/or patch.

License

Copyright (c) 2020-2025 Ben O'Neill [email protected]. This work is released under the terms of the MIT License. See LICENSE for the license terms.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL