wgp: command line client for wgetpanel (github.com/cumulus13/wgetpanel)

wgetpanel cli client. talks to the server's API v1 with a per-device token. Needs requests and asciichartpy (graphs).

pip install wgp
# or 
pip install git+https://github.com/cumulus13/wgetpanel/cli
# or
pip install -r cli/requirements.txt
wgp login http://localhost:8000 -u admin     # asks for the password, token saved in ~/.config/wgetpanel/config.json (0600)

Optional single executable (built and run on Linux; a Windows .exe has to be built on Windows, not tested here):

pip install pyinstaller && pyinstaller --onefile --name wgp cli/wgp.py     # -> dist/wgp

Global options (--host --token --timeout --insecure-tls --json) work before or after the command. Environment: WGP_HOST, WGP_TOKEN, WGP_CONFIG, WGP_PASSWORD, WGP_HTTP_PASSWORD, NO_COLOR, WGP_ASCII=1. Exit codes: 0 ok, 1 refused / nothing affected / a waited download failed, 2 usage, login or connection problem.

Examples:

wgp add https://example.com/big.iso --retry always --limit 500 --at 02:00      # keep trying forever, 500 KB/s, start tonight
wgp add -f urls.txt --retry 5 -w                                               # 5 consecutive failures allowed, wait for all
wgp watch                                                                      # live view, Ctrl-C to quit
wgp remove 3-9 --delete-files                                                  # drop from the list AND delete the files
wgp settings set retry.default_max 3 files.delete_on_remove true
wgp list --json | jq '.downloads[] | select(.status=="error") | .id'

Notes: --at HH:MM / --in use the local clock of the machine running wgp. get cannot resume an interrupted transfer (the server does not support Range requests yet). Colors and unicode bars are switched off for pipes, NO_COLOR and WGP_ASCII=1.

for cli args with colors use rchf (pip install rchf)

👤 Author

Hadi Cahyadi

Support me on Patreon