mitufe

command module
v0.99.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 29, 2021 License: MIT Imports: 9 Imported by: 0

README

mitufe

GoDocDownload package Download docker coverage report Go Report Card Liberapay

CLI/TUI rss reader, client for Miniflux, offline-first, highly customizable

Documentation

Install
GNU/Linux distributives' packages

Available on releases page

Docker
docker run -it --rm registry.gitlab.com/rakshazi/mitufe -h
Go
go install gitlab.com/rakshazi/mitufe@latest
mitufe -h

NOTE: configuration and local db saved into /home/mitufe/.config/mitufe directory, don't forget to use it as volume

Usage
Usage of mitufe:
  --sync
        Only sync, do not show TUI, just update db and exit
  --date-format string
        Date format, allowed values can be found here: https://golang.org/pkg/time/#pkg-constants (default "02 Jan 06 15:04")
  --sort-direction string
        Sort direction, allowed values: asc (newest first), desc (oldest first) (default "asc")
  --sort-order string
        Field name used for sorting, check miniflux docs for list of available fields (default "published_at")
  -p string
        Miniflux user password, only if you want to use login/password auth, used only once to generate config
  -s string
        Miniflux server URL, example: https://miniflux.app, used only once to generate config
  -t string
        Miniflux user API token, only if you want to use token auth, used only once to generate config
  -u string
        Miniflux user login, only if you want to use login/password auth, used only once to generate config
keyboard hotkeys

this app uses vim-like controls

main view:

  • j, down arrow - Move down.
  • k, up arrow - Move up.
  • g, home - Move to the top.
  • G, end - Move to the bottom.
  • T - Toggle entries, show unread or read entries
  • Ctrl+j - Next feed
  • Ctrl+k - Previous feed
  • Ctrl+g - First feed
  • q, ESC, Ctrl+C - Close app

article view:

  • l - Next article.
  • j, down arrow - Move down.
  • k, up arrow - Move up.
  • g, home - Move to the top.
  • G, end - Move to the bottom.
  • Ctrl-F, page down - Move down by one page.
  • Ctrl-B, page up - Move up by one page.
  • q, ESC - Close article view.

Check the documentation - Configuration

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL