Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zMoooooritz/nachrichten
Stay informed without leaving your command line
https://github.com/zMoooooritz/nachrichten
cli go news
Last synced: 21 days ago
JSON representation
Stay informed without leaving your command line
- Host: GitHub
- URL: https://github.com/zMoooooritz/nachrichten
- Owner: zMoooooritz
- License: mit
- Created: 2023-09-17T15:32:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-07T21:51:56.000Z (4 months ago)
- Last Synced: 2024-09-07T22:52:47.322Z (4 months ago)
- Topics: cli, go, news
- Language: Go
- Homepage:
- Size: 10.1 MB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- charm-in-the-wild - nachrichten - Access up-to-date news in German provided by the [Tagesschau](https://www.tagesschau.de/). (_built with Bubble Tea_) (Applications / RSS and News)
README
nachrichten
======
[](https://github.com/zMoooooritz/nachrichten/releases)
[](https://pkg.go.dev/github.com/zMoooooritz/nachrichten)
[](/LICENSE)
[](https://github.com/zMoooooritz/nachrichten/actions)
[](https://goreportcard.com/report/zMoooooritz/nachrichten)
Stay informed without leaving your command line
Access up-to-date news in German provided by the [tagesschau](https://www.tagesschau.de/)
## ⇁ Installation
### Package Manager
```bash
# Arch Linux (btw)
yay -S nachrichten # only AUR
```
### Go
Install directly using `go`
```bash
go install github.com/zMoooooritz/nachrichten@latest
```
or download from [releases](https://github.com/zMoooooritz/nachrichten/releases)
## ⇁ Usage
Run the `nachrichten` command to launch the minimalistic yet informative terminal interface
```bash
Usage of nachrichten:
-config string
Path to configuration file
-debug string
Path to log file
-shortnews
Only open the current short news
-version
Display version
```
### Viewers
The application offers three different viewers:
1. **Article Viewer**: Displays the full text of the respective article.
2. **Image Viewer**: Shows the thumbnail image associated with the article, rendered as ASCII art.
3. **Details Viewer**: Provides detailed information about the article and lists related articles. You can open related articles by pressing the corresponding number key.
## ⇁ Configuration
The tool does allow for user customization
1. **Theme** - Adapt the used colors in order to change the look and feel of the application
2. **Keybinds** - Customize all keys used within the application
3. **Applications** - Some news related resources can't be shown in a TUI, configure the apps used to open those resources
4. **Settings** - General settings that alter the behavior of the application
An example configuration can be found [here](https://github.com/zMoooooritz/nachrichten/blob/master/configs/config.yaml)
The default keybinds are as follows:
| Key | Action |
| ---------------- | ---------------------- |
| arrows / hjkl | navigation |
| g / G | goto start / end |
| tab / shift+tab | change tabs |
| pgup / pgdown | page up / down |
| / | open search dialog |
| enter | confirm search input |
| esc | abort search input |
| f | maximize reader/viewer |
| a | show article view |
| i | show thumbnail view |
| d | show details view |
| o | open article url |
| v | open article vod |
| s | open current news vod |
| ? | toggle help |
| q / esc / ctrl+c | quit |
## ⇁ Built with
- [bubbletea](https://github.com/charmbracelet/bubbletea) and its awesome ecosystem