From 7dc418e5b14596e3c4a7bfde4c84cbe8dcc3fbda Mon Sep 17 00:00:00 2001 From: "a. fox" Date: Fri, 17 Nov 2023 14:43:25 -0500 Subject: [PATCH] updated readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 9e3f542..33cab97 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,27 @@ a command line utility to bulk download media from jellyfin servers (e.g., shows ## Running +``` +$ ./seanut --help + +Usage: seanut [-h|--help] [--version] [-v|--verbose] [--no-prompt] + [-q|--quick-connect] [-t|--token TOKEN] [-o|--output DIR] [-m|--media-type TYPE] + [-u|--username USERNAME] [-p|--password PASSOWRD] [-s|--season SEASON] DOMAIN MEDIA-NAME + +Available options: + -h, --help prints this help + --version prints the version + -v, --verbose prints file names as they get downloaded + --no-prompt assumes yes for all download prompts + -q, --quick-connect alternative login method to providing username/password - times out after ~1min + -t, --token TOKEN access token - if you do not have one please authenticate first + -o, --output DIR location to save downloaded media + -m, --media-type TYPE media type to base our query on + -u, --username USERNAME username for the jellyfin server + -p, --password PASSOWRD passowrd for the jellyfin server + -s, --season SEASON specify specific season to download, if downloading a show +``` + `$ ./seanut -u Username -p hunter2 -m MusicAlbum -o ~/Downloads/Jellyfin/Media https://your.jellyfin.domain "My Cool Album"` `$ ./seanut -q -m MusicAlbum -o ~/Downloads/Jellyfin/Media https://your.jellyfin.domain "My Cool Album"`