~bacardi55/walgot

A Wallabag TUI client in golang

dc20972 Implements: Open links from entry content (L keybind on detail view)

1 year, 2 months ago

7bef13f add screenshot doc page

1 year, 3 months ago

#Walgot - a WALlabag GO Tui client

builds.sr.ht status license: AGPL-3.0-only

Official repository and project is on sourcehut. Github and codeberg are only mirrors. This is where binaries are uploaded.

#What is walgot?

Walgot is a TUI wallabag client. Wallabag is an opensource "read it later" application that can be selfhosted. This application aims to be an easy and interactive TUI client for it.

Walgot is built in golang, leveraging the great bubbletea set of libraries and Wallabago, a wrapper to wallabag APIs.

Mandatory screenshots:

Walgot article list view Walgot article detail view

#Online only at this stage

Important note: The way walgot works is by downloading all articles from wallabag API at the start of the session (or when using the refresh keybind). Then walgot will allow filtering, viewing or updates (read, star) of articles and push changes via API. There is no local cache or database, so no offline usage (at least for now).

Once the initial load is done, internet access is not needed anymore to read articles content. It is needed for changing article status (like read or star). An offline mode might be added later, but there are more urgent features to build first :).

#Installation, configuration and usage

See the installation and configuration documentation page.

#Keybinds

At any time, press ? key to display the help and ctrl+c to quit.

See the full list on the keybind documentation page.

#Existing features and remaining TODOs:

High level available features at this stage:

  • [x] Retrieve articles from wallabag
  • [x] List articles view - columns depends on screen size.
  • [x] Article detail view
  • [x] Action on article
  • [x] Status update (toggle read, starred and public status)
  • [x] Configurable (see: )
  • [x] Add Search (more a filter of article's title)
  • [x] Add / Delete entry to wallabag
  • [x] Open public/original article link
  • [x] Yank/Copy public/original article URL

See the more detailed todo documentation page.

#More Screenshots

See the screenshots directory directory.

#Help and feedback always welcome

Feedback or request? Send an email to the dev mailing list. You can also read the mailing list archive.

You can subscribe to the announcement mailing list.