Reddittui

A lightweight terminal application for browsing Reddit from your command line. Powered by bubbletea

Features

• Subreddit Browsing: Navigate through your favorite subreddits.
• Post Viewing: Read text posts and comments.
• Keyboard Navigation: Scroll and select posts using vim/standard keyboard shortcuts.
• Configurable: Customize caching behavior and define subreddit filters using a configuration file

Demo

demo.mov

Prerequisites

• Go: Version 1.16 or newer
• Terminal: A Unix-like terminal (Linux, macOS, or similar).
• POSIX Utilities: The install command is used for installation, which is available on both Linux and macOS.

Installation

Clone the repository and run the install script:

git clone https://github.com/tonymajestro/reddit-tui.git reddittui
cd reddittui
./install.sh

Usage

Run the installed binary from your preferred terminal:

reddittui

Keybindings

• Navigation
  • h, j, k, l: vim movement
  • left, right, up, down: normal movement
• Posts page
  • s: Switch subreddits
• Comments page
  • o: Open post link in browser
  • c: Collapse comments
• Misc
  • H: Go to home page
  • backspace: Go back
  • q, esc: Exit reddittui

Configuration

After running the reddittui binary, a configuration file will be created at ~/.config/reddittui/reddittui.toml. Example configuration file:

# Core configuration
[core]
bypassCache = false
logLevel = "Debug"
clientTimeout = 10

# Filter out posts containing keywords or belonging to certain subreddits
[filter]
subreddits = ["news", "politics"]
keywords = ["pizza", "pineapple"]

Acknowledgments

Reddittui is based on the bubbletea framework. It also takes inspiration from circumflex, a hackernews terminal browser.