gallery-dl is a command-line program to download image-galleries and -collections from several image hosting sites (see Supported Sites). It is a cross-platform tool with many configuration options and powerful filenaming capabilities.
- FFmpeg: Pixiv Ugoira to WebM conversion
- youtube-dl: Video downloads
- pyOpenSSL: Access Cloudflare protected sites
The stable releases of gallery-dl are distributed on PyPI and can be easily installed or upgraded using pip:
$ python3 -m pip install --upgrade gallery-dlInstalling the latest dev-version directly from GitHub can be done with pip as well:
$ python3 -m pip install --upgrade https://github.com/mikf/gallery-dl/archive/master.tar.gzNote: Windows users should use py -3 instead of python3.
setuptools and wheel.$ python3 -m pip install --upgrade pip setuptools wheelGet the code by either
- Downloading a stable or dev archive and unpacking it
- Or via
git clone https://github.com/mikf/gallery-dl.git
Navigate into the respective directory and run the setup.py file.
$ wget https://github.com/mikf/gallery-dl/archive/master.tar.gz
$ tar -xf master.tar.gz
# or
$ git clone https://github.com/mikf/gallery-dl.git
$ cd gallery-dl*
$ python3 setup.py installDownload a standalone executable file,
put it into your PATH,
and run it inside a command prompt (like cmd.exe).
These executables include a Python 3.7 interpreter and all required Python packages.
Linux users that are using a distro that is supported by Snapd can install gallery-dl from the Snap Store:
$ snap install gallery-dlTo use gallery-dl simply call it with the URLs you wish to download images from:
$ gallery-dl [OPTION]... URL...See also gallery-dl --help.
Download images; in this case from danbooru via tag search for 'bonocho':
$ gallery-dl "https://danbooru.donmai.us/posts?tags=bonocho"Get the direct URL of an image from a site that requires authentication:
$ gallery-dl -g -u "<username>" -p "<password>" "https://seiga.nicovideo.jp/seiga/im3211703"$ gallery-dl "r:https://pastebin.com/raw/FLwrCYsT"Configuration files for gallery-dl use a JSON-based file format.
gallery-dl searches for configuration files in the following places:
| Linux | Windows |
|
|
(%USERPROFILE% usually refers to the user's home directory,
i.e. C:\Users\<username>\)
Values in later configuration files will override previous ones.
Some extractors require you to provide valid login-credentials in the form of
a username & password pair. This is necessary for
pixiv, nijie, and seiga
and optional (but strongly recommended) for
danbooru, exhentai, idolcomplex, instagram,
luscious, sankaku, tsumino, and twitter.
You can set the necessary information in your configuration file (cf. gallery-dl.conf)
{
"extractor": {
...
"pixiv": {
"username": "<username>",
"password": "<password>"
}
...
}
}
or you can provide them directly via the
-u/--username and -p/--password or via the
-o/--option command-line options
$ gallery-dl -u <username> -p <password> URL
$ gallery-dl -o username=<username> -o password=<password> URLgallery-dl supports user authentication via OAuth for
deviantart, flickr, reddit, smugmug and tumblr.
This is entirely optional, but grants gallery-dl the ability
to issue requests on your account's behalf and enables it to access resources
which would otherwise be unavailable to a public user.
To link your account to gallery-dl, start by invoking it with
oauth:<site-name> as an argument. For example:
$ gallery-dl oauth:flickrYou will be sent to the site's authorization page and asked to grant read access to gallery-dl. Authorize it and you will be shown one or more "tokens", which should be added to your configuration file.