Update README

This commit is contained in:
7x11x13
2025-03-21 13:47:03 -04:00
parent 5b1a926e49
commit cd2825e1e6
+33 -25
View File
@@ -1,12 +1,13 @@
# free-bandcamp-downloader # free-bandcamp-downloader
Download free and $0 minimum name-your-price albums and tracks from Bandcamp (including ones that are sent to email), Download free and $0 minimum name-your-price albums and tracks from Bandcamp (including ones that are sent to email),
and tag them with data from the Bandcamp page. Also able to download items in your collection, if login cookies are and tag them with data from the Bandcamp page. Also able to download items in your collection, if login cookies are
supplied using the `--cookies` or `--identity` argument. supplied using the `--cookies` or `--identity` argument.
## Installation ## Installation
Install with pip Install with pip
``` ```
pip install free-bandcamp-downloader pip install free-bandcamp-downloader
``` ```
@@ -21,33 +22,40 @@ argument which you must supply the value of your "identity" cookie.
``` ```
Usage: Usage:
bcdl-free (-a <URL> | -l <URL>)[--force][--no-unzip][-d | --dir <dir>][-e | --email <email>] bcdl-free setdefault [-d <dir>] [-e <email>] [-z <zipcode>]
[-z | --zipcode <zipcode>][-c | --country <country>][-f | --format <format>] [-c <country>] [-f <format>]
[--cookies <file>][--identity <value>][--debug]
bcdl-free setdefault [-d | --dir <dir>][-e | --email <email>][-z | --zipcode <zipcode>]
[-c | --country <country>][-f | --format <format>]
bcdl-free defaults bcdl-free defaults
bcdl-free clear bcdl-free clear
bcdl-free (-h | --help) bcdl-free -h | --help | --version
bcdl-free --version bcdl-free [--debug] [--force] [--no-unzip] [-al]
[-d <dir>] [-e <email>] [-z <zipcode>] [-c <country>] [-f <format>]
[--cookies <file>] [--identity <value>] [--download-history-file <file>]
URL...
Arguments:
URL URL to download. Can be a link to a label or release page
Subcommands:
setdefaults set default configuration options
defaults list default configuration options
clear clear default configuration options
Options: Options:
-h --help Show this screen -h --help Show this screen
--version Show version --version Show version
-a <URL> Download the album at URL --force Download even if album has been downloaded before
-l <URL> Download all free albums of the label at URL --no-unzip Don't unzip downloaded albums
--force Download even if album has been downloaded before --debug Set loglevel to debug
--no-unzip Don't unzip downloaded albums -a -l Dummy options, for backwards compatibility
setdefault Set default options -d <dir> --dir <dir> Set download directory
defaults List the default options -c <country> --country <country> Set country
clear Clear download history -z <zipcode> --zipcode <zipcode> Set zipcode
-d --dir <dir> Set download directory -e <email> --email <email> Set email (set to 'auto' to automatically download from a disposable email)
-c --country <country> Set country -f <format> --format <format> Set format
-z --zipcode <zipcode> Set zipcode --cookies <file> Path to cookies.txt file so albums in your collection can be downloaded
-e --email <email> Set email (set to 'auto' to automatically download from a disposable email) --identity <value> Value of identity cookie so albums in your collection can be downloaded
-f --format <format> Set format --download-history-file <file> Path to history file containing downloaded albums
--cookies <file> Path to cookies.txt file so albums in your collection can be downloaded
--identity <value> Value of identity cookie so albums in your collection can be downloaded
--debug Set loglevel to debug
Formats: Formats:
- FLAC - FLAC
- V0MP3 - V0MP3