gallery-dl is a command-line program to download image-galleries and -collections from several image hosting sites such as pixiv.net, exhentai.org, danbooru.donmai.us and several more (see Supported Sites). It requires Python 3.3+ to run and works on Unix-like systems as well as on Windows.
The stable releases of gallery-dl are distributed on PyPI and can be easily installed or upgraded using pip:
$ pip install --upgrade gallery-dl
Installing the latest dev-version directly from GitHub can be done with pip as well:
$ pip install --upgrade https://github.com/mikf/gallery-dl/archive/master.zip
You can also install gallery-dl manually:
Get the code by either
Navigate into the respective directory and run the setup.py
file.
$ wget https://github.com/mikf/gallery-dl/archive/master.zip
$ unzip master.zip
# or
$ git clone https://github.com/mikf/gallery-dl.git
$ cd gallery-dl
$ python setup.py install
Windows users can download a standalone executable, which comes with a Python interpreter and all required packages included.
Put this file in your PATH or use it from the current directory and you are good to go,
To 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 http://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> http://seiga.nicovideo.jp/seiga/im3211703
$ gallery-dl r:https://pastebin.com/raw/FLwrCYsT
- pixiv.net
- seiga.nicovideo.jp
- nijie.info
- mangastream.com
- kissmanga.com
- readcomiconline.to
- danbooru.donmai.us
- gelbooru.com
- exhentai.org
- nhentai.net
- luscious.net
- hentai-foundry.com
- deviantart.com
- tumblr.com
- Complete List
Configuration files for gallery-dl use a JSON-based file format. For a (more or less) complete example, see gallery-dl.conf. A list of all available configuration options and their descriptions can be found in configuration.rst.
gallery-dl searches for configuration files in the following paths:
Linux | Windows |
|
|
(%USERPROFILE%
usually refers to the users 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 exhentai
and sankaku
.
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> URL
gallery-dl supports user authentication via OAuth for
deviantart
, flickr
, reddit
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:flickr
You will be sent to the site's authorization page and asked to grant read access to gallery-dl. Authorize it and you will he shown one or more "tokens", which should be added to your configuration file.