miniflux-tui-py¶

A Python Terminal User Interface (TUI) client for Miniflux - a self-hosted RSS reader. Keyboard-driven, with vim-style navigation, feed/category management, runtime theme switching, and non-blocking background sync.

Status: Production/Stable — see the feature overview for the full list.

Quick Start¶

uv tool install miniflux-tui-py
miniflux-tui --init      # writes a starter config
miniflux-tui             # run it

See the Installation Guide for pip/source installs and Codespaces.

Documentation¶

• Installation Guide
• Configuration
• Usage Guide — including the full keyboard shortcut reference
• Feature Overview
• Contributing
• API Reference

Requirements¶

• Python 3.11+ (tested on 3.11-3.14, 3.15 preview)
• A running Miniflux instance
• Terminal with 24+ colors (for best experience)

License¶

MIT License - see LICENSE file for details.

Author¶

Peter Reuterås (@reuteras)