zMoooooritz / nachrichten

Stay informed without leaving your command line
MIT License
16 stars 0 forks source link
cli go news

nachrichten

Latest Release Go Doc Software License Build Status Go ReportCard

Stay informed without leaving your command line

Access up-to-date news in German provided by the tagesschau

Welcome to nachrichten

⇁ Installation

Package Manager

# Arch Linux (btw)
yay -S nachrichten # only AUR

Go

Install directly using go

go install github.com/zMoooooritz/nachrichten@latest

or download from releases

⇁ Usage

Run the nachrichten command to launch the minimalistic yet informative terminal interface

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

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