https://github.com/liamg/happen
https://github.com/liamg/happen
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/liamg/happen
- Owner: liamg
- Created: 2023-06-06T19:37:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T23:29:15.000Z (over 2 years ago)
- Last Synced: 2025-02-27T04:24:54.020Z (11 months ago)
- Language: Go
- Size: 172 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# happen
A hacked together terminal-based feed reader, created for my own use. Designed to tick away in a window and surface recent items of interest in a chat-like view.
Configure desired feeds in the config file at `~/.config/happen.yaml` (will be created with default settings after running once.)
## Installation
Install with go:
```bash
go install github.com/liamg/happen@latest
```
## Key Bindings
| Key | Description |
| ----------------------- | ----------- |
| `up`/`k` | Move selection up |
| `down`/`j` | Move selection down |
| `pageup` | Page selection up |
| `pagedown` | Page selection down |
| `home`/`g`/`0` | Move up to oldest item |
| `end`/`G`/`$` | Move down to newest item |
| `esc` | Clear selection |
| `enter` | Open selected item in default browser |
| `i` | Open image for selected item (if it has one) |
| `/` | Filter/search items. Use `enter` to confirm and escape to `cancel/clear` |
| `r` | Refresh feeds |
| `q` | Exit |
## Config File
```yaml
showDescriptions: true # show a description/content preview under each item
showHelp: true # show the help strip at the bottom of the window, showing shortcuts + time to next update
maxBadgeSize: 16 # max length of badge names
pollInterval: 1m # how often to poll - can use h/m/s
subreddits: # list of subreddits to add to the feed
- blueteamsec
- cloudsecurity
- blackhat
- cyber
- cybersecurity
- exploitdev
- malware
- redteamsec
- pwned
sources: # list of generic feed sources - all parameters are optional except url
- name: BBC
url: https://feeds.bbci.co.uk/news/world/rss.xml
bg: '#930000' # badge background colour
fg: '#e4e6e9' # badge foreground colour
maxAge: 4h # oldest items to display from the feed
- name: Hacker News
url: https://hnrss.org/newest?points=20
bg: '#cc5200'
fg: '#e4e6e9'
maxAge: 8h
- name: lobste.rs
url: https://lobste.rs/rss
bg: '#5e0000'
fg: '#ffffff'
maxAge: 24h
```