wallabag-stats

command module
v0.0.0-...-2ff3302 Latest Latest
Warning

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

Go to latest
Published: Feb 25, 2023 License: GPL-3.0 Imports: 18 Imported by: 0

README

wallabag-stats

Draws a chart for unread and total articles in your wallabag instance.

Chart is only created when there at least two data sets, in which unread and total are both different compared with their previous value. Otherwise, if the delta is zero, the go-chart lib does not print a chart.

Example

Example chart

Install

Copy example/config.json along with your wallabag-stats binary and change it according to your wallabag instance.

Updates via Cron

You can install a cronjob to fetch the stats data from your wallabag and let the graph being printed on changes. E.g. a user cronjob line by editing your cronjob file via cronjob -e:

* * * * * cd /home/$USER/opt/wallabag-stats/ && ./wallabag-stats && cp -r output/ /var/www
Updates via systemd Timer

TODO :)

wallabag-stats -h

Usage of ./wallabag-stats:
  -config string
    	file name of config JSON file (default "config.json")
  -d	get debug output (implies verbose mode)
  -data string
    	file name of data JSON file (default "data.json")
  -data-only
    	collect data only, do not generate any charts
  -dd
    	get even more debug output like data (implies debug mode)
  -f	force regeneration of charts and html even if no new data is present
  -pretty-json
    	prints all data as formatted json
  -print-table
    	prints all data as ascii table
  -v	print version
  -validate
    	get through every data item and sort invalid data entries out
  -verbose
    	verbose mode

Project Status

Go Report Card

Go Report Card

How to release

git tag x.yz
git push --tags
goreleaser --rm-dist

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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