gallery-dl

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.

Dependencies

Python 3.4+
Requests

Optional

FFmpeg: Pixiv Ugoira to WebM conversion
youtube-dl: Video downloads

Installation

Pip

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

Be sure the Python interpreter used for pip is version 3.4 or higher. You might have to use pip3 or python3 -m pip depending on your system's defaults.

From Source

Get 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.zip
$ unzip master.zip
# or
$ git clone https://github.com/mikf/gallery-dl.git

$ cd gallery-dl
$ python setup.py install

Standalone Executable (Windows only)

Windows users can download a standalone executable, which comes with a Python 3.4 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,

Usage

To use gallery-dl simply call it with the URLs you wish to download images from:

$ gallery-dl [OPTION]... URL...

Examples

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

Search a remote resource for URLs and download images from them:

(URLs for which no extractor can be found will be silently ignored)

$ gallery-dl r:https://pastebin.com/raw/FLwrCYsT

Configuration

Configuration files for gallery-dl use a JSON-based file format.

For a (more or less) complete example with options set to their default values, see gallery-dl.conf.

For a configuration file example with more involved settings and options, see gallery-dl-example.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 places:

Linux	Windows
`/etc/gallery-dl.conf` `${HOME}/.config/gallery-dl/config.json` `${HOME}/.gallery-dl.conf`	`%USERPROFILE%\gallery-dl\config.json` `%USERPROFILE%\gallery-dl.conf`

(%USERPROFILE% usually refers to the user's home directory, i.e. C:\Users\<username>\)

Values in later configuration files will override previous ones.

Authentication

Username & Password

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, luscious, sankaku, idolcomplex, tsumino and wallhaven.

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

OAuth

gallery-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: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.

amlouden/gallery-dl