Skip to main content

Command-line program to download image-galleries and -collections from several image hosting sites

Project description

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.

pypi build gitter





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

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

Navigate into the respective directory and run the file.

$ wget
$ unzip
# or
$ git clone

$ cd gallery-dl
$ python install

Standalone Executable

Download 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-dl


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

Get the direct URL of an image from a site that requires authentication:

$ gallery-dl -g -u <username> -p <password>
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:


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.


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 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> URL


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 be shown one or more “tokens”, which should be added to your configuration file.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gallery-dl, version 1.10.2
Filename, size & hash File type Python version Upload date
gallery_dl-1.10.2-py3-none-any.whl (312.5 kB) View hashes Wheel py3
gallery_dl-1.10.2.tar.gz (224.0 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page