miniflux-tui-py

A Python Terminal User Interface (TUI) client for Miniflux - a self-hosted RSS reader. This tool provides a keyboard-driven interface to browse, read, and manage RSS feeds directly from the terminal.

Features

• Keyboard-driven navigation - Vim-style keybindings for efficient browsing
• Multiple view modes - Group by feed, sort by date/feed/status
• Feed management - Mark entries as read/unread, star/unstar favorites
• Collapsible feed groups - Expand/collapse feeds to focus on what matters
• Responsive layout - Optimized for terminal viewing
• Secure configuration - Support for self-signed certificates and custom API keys

Quick Start

Installation (Recommended with uv)

# Install uv - see https://docs.astral.sh/uv/getting-started/installation/
# On macOS/Linux: brew install uv
# On Windows: choco install uv

# Install miniflux-tui-py
uv tool install miniflux-tui-py

Configuration

Create your configuration with:

miniflux-tui --init

This will prompt you for your Miniflux server URL and API key.

Running

miniflux-tui

See the Installation Guide for more options including pip and source installation.

Key Bindings

Key	Action
j / k	Navigate down/up
Enter	Open entry
m	Mark as read/unread
*	Toggle star
s	Cycle sort mode
g	Toggle group by feed
l / h	Expand/collapse feed
r	Refresh entries
u	Show unread entries
t	Show starred entries
?	Show help
q	Quit

Documentation

• Installation Guide
• Configuration
• Usage Guide
• Contributing
• API Reference

Requirements

• Python 3.11 or later
• A running Miniflux instance
• Terminal with 24+ colors (for best experience)

License

MIT License - see LICENSE file for details

Author

Peter Reuterås (@reuteras)