moccasin

A TUI feed reader for RSS, Atom, and (eventually) Podcasts. VIM keybindings. Ranger-inspired interface. Configurable.

Installation

cargo install moccasin

Usage

Since "moccasin" is hard to spell and has too many letters, the executable is just called mcsn.

mcsn [OPTIONS]

Options

Command line arguments will override any values set in your config file for that session.

Config

On first boot, Moccasin will create both a database and a config file in your default config directory, which varies by platform:

The moccasin.toml file in this directory can be edited to customize app behavior, add feeds in bulk, change the color scheme, etc. Most of these properties can be changed from within the application as well, which will write to this file. Configuration options are as follows:

moccasin.toml

Color Schemes

To create a custom color scheme, the color_scheme field can be declared as a table in which the keys are interface elements and the values are either a built-in ANSI color (which will inherit from your terminal emulator), a HEX color, or in InlineTable with fg and bg properties of the same type.

[preferences.color_scheme]
base = { fg = "white", bg = "#000080" }
status = { fg = "gray", bg = "#000080" }
border = "gray"
selection_active = { fg = "#000080", bg = "#fefd72" }
scrollbar = { fg = "white", bg = "gray" }

The built-in color names are

• "white"
• "black"
• "red"
• "green"
• "yellow"
• "blue"
• "magenta"
• "cyan"
• "gray"
• "lightred"
• "lightgreen"
• "lightyellow"
• "lightblue"
• "lightmagenta"
• "lightcyan"
• "lightblack" | "darkgray"

The styleable properties are all optional, inheriting sensible defaults. Available properties are as follows:

* NOTE: it is important to define border when the style it inherits (either base or border_active) is defined as a hex color, otherwise it will be difficult to know which panel is currently active.

Keybinds

The application uses VIM-style keybinds, but arrow keys can also be used for navigation. At the moment, the app has a NORMAL mode and a COMMAND mode. In future, you should also be able to tag and group feeds and items in GROUP mode.

NORMAL mode

COMMAND mode

License

MIT © Tobias Fried