cleed — A command line tool for effortless feed reading.

Pitch

Description

Comments

About this project

cleed is a simple yet powerful feed reader designed for the command line. It allows users to follow, display, and search through multiple feeds efficiently, making it ideal for those who prefer a text-based interface for their news and updates.

cleed is a lightweight command-line feed reader designed to streamline the process of following, managing, and exploring RSS feeds right from the terminal. With cleed, users can easily add and organize feeds into lists, display updates, and even search through items using keywords or regular expressions. The project is built for efficiency and flexibility in consumption of content from various sources.

Key Features

Follow Feeds: Quickly add single or multiple feeds to your list with ease. For example:

cleed follow https://example.com/feed.xml
cleed follow https://example.com/feed.xml https://example2.com/feed --list mylist

Display Feeds: View all feeds or filter results based on specific criteria such as list names, dates, or limits:
```
cleed
cleed --list my-list
cleed --since "2024-01-01 12:03:04"
cleed --limit 10
```
Search and Filter: Perform keyword searches across feeds or use regular expressions for precise filtering:
```
cleed --search "keyword" --limit 10
cleed --searchr "^keyword"
```
Feed Management: The tool provides comprehensive options to unfollow feeds, list them, and manage lists directly from the command line:
```
cleed unfollow https://example.com/feed.xml
cleed list mylist --rename newlist
```
Configuration Options: Personalize cleed with various configuration commands to set preferences like user agents, color mapping, and data paths:
```
cleed config --user-agent="My User Agent"
cleed config --map-colors=0:230,1:213
```
Integration with Miniflux: Easily push or pull feeds from Miniflux, allowing for seamless synchronization with a popular feed management service:
```
cleed miniflux push
cleed miniflux pull
```
Explore Feeds: Discover new content through external repositories, import feeds, and fetch updates from sources:
```
cleed explore
cleed explore --import --limit 0
```

For those who prefer customization, cleed allows users to set a custom data directory by specifying the CLEED_DATA_PATH environment variable. With comprehensive help options available through cleed --help, users can quickly learn about available commands and their functionalities.

In summary, cleed presents a modern approach to reading feeds effectively in a terminal environment, catering to users seeking a straightforward, yet highly configurable command-line tool.