- 📢 Stay up-to-date! Subscribe to the [eilmeldung release atom feed](https://github.com/christo-auer/eilmeldung/releases.atom)! Press `c e` in eilmeldung to automatically add the feed!
- 🤖 Want to use your **AI/LLM chatbot with eilmeldung** to select and summarize articles? Or do you want eilmeldung to stay clear of all this AI fuzz? Take part in the [survey (demo inside)](https://github.com/christo-auer/eilmeldung/issues/197) and let me know what you think!


![Logo of eilmeldung](docs/images/logo.png) 
  

![Screenshot of eilmeldung](docs/images/hero-shot.png) 

*eilmeldung* is a *TUI RSS reader* based on the awesome [news-flash](https://gitlab.com/news-flash/news_flash) library.  
- *fast* in every aspect: non-blocking terminal user interface, (neo)vim-inspired keybindings, instant start-up and no clutter
- *stands* on the shoulder of *giants*: based on the news-flash library, *eilmeldung* supports many RSS providers, is efficient and reliable
- *powerful* and yet *easy to use out-of-the-box*: sane defaults which work for most, and yet configurable to meet anyone's requirements, from keybindings to colors, from displayed content to RSS provider
- read news like a pro: filter and search news with an easy-to-learn powerful *query language*, activate *zen mode* to focus on the article content and nothing else

*eilmeldung* is German for *breaking news*

---

## Table of Contents

- [Showreel](#showreel)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Quick Reference](#quick-reference)
- [Documentation](#documentation)
- [Alternatives](#alternatives)
- [FAQ](#faq)
- [Credits](#credits)
- [Contributing](#contributing)

---

# Showreel

https://github.com/user-attachments/assets/ddd731dd-3fce-43c2-80fd-dafb20520873

This video demonstrates
- basic (vim-like) navigation and reading
- *zen* mode: just show content
- creating new tags and tagging an article
- *filtering* and *searching* article list by using article queries
- *tagging* multiple articles by using an article query

---

# Installation 

**Quick install:**

- **Homebrew**: `brew tap christo-auer/eilmeldung  https://github.com/christo-auer/eilmeldung && brew install eilmeldung`
- **Arch (AUR)**: `paru -S eilmeldung` or `yay -S eilmeldung`
- **Cargo**: `cargo install eilmeldung` (you need to install [build dependencies](docs/installation.md) first!)

**Important**: You need a [Nerd Font](https://github.com/ryanoasis/nerd-fonts) compatible font/terminal for icons to display correctly!

For detailed installation instructions including Nix/Home Manager setup, see **[Installation Guide](docs/installation.md)**.

---

# Quick Start

1. **Install** eilmeldung (see above)
2. **Run** `eilmeldung` - you'll be guided through the initial setup
3. **Choose a provider** (select "Local" if you're new to RSS)
4. **Add feeds** with `c f` or import an OPML file with `:importopml path/to/file.opml`
5. **Sync** your feeds with `s`
6. **Start reading!** Use `j`/`k` to navigate up/down, `h`/`l` to navigate between panels, `o` to open articles in the browser, `z` to enjoy "zen mode"

Press `?` anytime to see all available commands!

For a comprehensive getting started guide, see **[Getting Started](docs/getting-started.md)**.

---

# Quick Reference

Here are some key bindings to get you started.

| Key             | Action                                                        |
| -----           | --------                                                      |
| `?`             | Show all key bindings (search with `/`!)                      |
| `s`             | Sync all feeds                                                |
| `j` / `k`       | Move down / up                                                |
| `h` / `l`       | Move between panels (left/right)                              |
| `o`             | Open article in browser, mark as read, jump to next unread    |
| `r` / `u`       | Mark as read / unread                                         |
| `m` / `v`       | Mark (star) / unmark article                                  |
| `/`             | Search articles                                               |
| `:`             | Open command line                                             |
| `q`             | Quit                                                          |
| `1` / `2` / `3` | Show all/only unread/only marked in feed list or article list |

**Tip:** Press `?` anytime to see all available commands, and use `/` in the help dialog to search!

**Another Tip**: Navigate to the article list and use `C-j`/`C-k` to move down/up in the feed list and use `M-k`/`M-j` to scroll the article content down/up. Of course, you can remap all keys to your liking.

---

# Documentation

Complete documentation is available in the `docs/` directory:

- **[Getting Started Guide](docs/getting-started.md)** - Setup and first steps
- **[Installation Guide](docs/installation.md)** - Detailed installation instructions
- **[Key Bindings Reference](docs/keybindings.md)** - Complete keybinding reference
- **[Commands Reference](docs/commands.md)** - All available commands
- **[Article Queries](docs/queries.md)** - Powerful search and filter syntax
- **[Configuration Guide](docs/configuration.md)** - Customize appearance and behavior
- **[Command Line Arguments](docs/cli_args.md)** - Available CLI options
- **[FAQ](docs/faq.md)** - Frequently asked questions

---

# Alternatives

Of course, there are many awesome alternatives to *eilmeldung*. Check them out!

- [newsboat](https://newsboat.org/) is the battle-proven classic
- [feedr](https://github.com/bahdotsh/feedr) is a feature-rich terminal-based RSS feed reader written in Rust
- [russ](https://github.com/ckampfe/russ)  is a TUI RSS/Atom reader with vim-like controls and a local-first, offline-first focus.
- [elfeed](https://github.com/skeeto/elfeed) provides RSS in emacs
- [tuifeed](https://github.com/veeso/tuifeed), a terminal news feed reader with a fancy ui 

---

# FAQ

### Which providers are supported?

See [news_flash_gtk for all supported providers](https://gitlab.com/news-flash/news_flash_gtk). 

### Does eilmeldung support smart folders?

Yes! Use queries in your feed list configuration. Example:

```toml
feed_list = [
  'query: "Important Today" #important unread today',
  'query: "Read Later" #readlater unread',
  "feeds",
]
```

### Can I customize keybindings and colors?

Absolutely! Everything is customizable via the [configuration file](docs/configuration.md). See `examples/default-config.toml` for all options.

### How do I save articles for later?

Create a tag (`:tagadd readlater red`), bind it to a key, and create a query in your feed list. See the [FAQ](docs/faq.md#how-can-i-save-articles-for-reading-later) for details.

### Can I hide feeds/categories/tags without unread/marked articles?

Yes, focus the feed list and press `2` / `3` to show only feeds/categories/tags with unread / marked articles, show all with `1`. Change the value of the configuration option `feed_list_scope` to either `all`, `unread` or `marked` to set the default value.


### Can I execute automatic operations after synchronisation/refresh?

Yes, via the option `after_sync_commands` [configuration](docs/configuration.md#after-sync_commands) for some recipes.

### Can I select articles and then mark them as read/unread/tag them etc.?

Yes, you can *flag* them by pressing `f` and then press `r` to mark all flagged articles as read. Similarly for `u`(unread), `m` (mark), `t` (tag), etc. Press `D` to remove all flags.

Checkout [FAQ](docs/faq.md#features--capabilities)!

### Is mouse input supported?

Yes, there is rudimentary mouse support with the option `mouse_support = true` (default is `false`). See [Mouse Support](docs/keybindings.md#mouse-support)]

---

**More questions?** See the complete [FAQ](docs/faq.md).

---

# Credits

## Standing on the Shoulders of Giants

*eilmeldung* was inspired by other awesome programs and libraries:

- [news-flash](https://gitlab.com/news-flash/news_flash) library and [news-flash GTK](https://gitlab.com/news-flash/news_flash_gtk), a modern Gnome/GTK RSS reader, both implemented in rust
- [newsboat](https://newsboat.org/) which has been my TUI RSS reader of choice for many years
- [spotify-player](https://github.com/aome510/spotify-player), a TUI spotify music player written in rust. In particular, the theming system and how input is handled has been a great inspiration for *eilmeldung*
- [vifm](https://vifm.info/), [neomutt](https://neomutt.org/) with [notmuch](https://notmuchmail.org/) inspired the filtering and article query systems
- [neovim](https://neovim.io/) and [vim](https://www.vim.org/) for their philosophy on user input
- [ratatui](https://ratatui.rs/) and all its supporting libraries for creating the TUI

## On the use of LLMs in this Project

This project was built as an experiment in learning Rust through LLM use. LLMs were used as tutors (asking questions, not providing solutions) and for documentation, but every line of code was intentionally written to solve a problem I understood.

📖 Read more about the LLM development approach in [LLM Development](docs/llm-development.md).

---

# Contributing

Contributions are welcome! Please feel free to:

- Report bugs or request features via [GitHub Issues](https://github.com/christo-auer/eilmeldung/issues)
- Submit pull requests
- Improve documentation
- Share your configuration examples

---

# License

See [LICENSE](LICENSE) file for details.
