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





The stable releases of gallery-dl are distributed on PyPI and can be easily installed or upgraded using pip:

python3 -m pip install -U gallery-dl

Installing the latest dev version directly from GitHub can be done with pip as well:

python3 -m pip install -U -I --no-deps --no-cache-dir

Note: Windows users should use py -3 instead of python3.

It is advised to use the latest version of pip, including the essential packages setuptools and wheel. To ensure these packages are up-to-date, run

python3 -m pip install --upgrade pip setuptools wheel

Standalone Executable

Prebuilt executable files with a Python interpreter and required Python packages included are available for

Nightly Builds

Executables build from the latest commit can be found at


Linux users that are using a distro that is supported by Snapd can install gallery-dl from the Snap Store:

snap install gallery-dl


Windows users that have Chocolatey installed can install gallery-dl from the Chocolatey Community Packages repository:

choco install gallery-dl


gallery-dl is also available in the Scoop “main” bucket for Windows users:

scoop install gallery-dl


For macOS or Linux users using Homebrew:

brew install gallery-dl


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

gallery-dl [OPTIONS]... URLS...

Use gallery-dl --help or see for a full list of all command-line options.


Download images; in this case from danbooru via tag search for ‘bonocho’:

gallery-dl ""

Get the direct URL of an image from a site supporting authentication with username & password:

gallery-dl -g -u "<username>" -p "<password>" ""

Filter manga chapters by chapter number and language:

gallery-dl --chapter-filter "10 <= chapter < 20" -o "lang=fr" ""
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:"

If a site’s address is nonstandard for its extractor, you can prefix the URL with the extractor’s name to force the use of a specific extractor:

gallery-dl "tumblr:https://sometumblrblog.example"


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


A list of all available configuration options and their descriptions can be found in

For a default configuration file with available options set to their default values, see
For a commented example with more involved settings and option usage, see


gallery-dl searches for configuration files in the following places:

  • %APPDATA%\gallery-dl\config.json

  • %USERPROFILE%\gallery-dl\config.json

  • %USERPROFILE%\gallery-dl.conf

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

Linux, macOS, etc.:
  • /etc/gallery-dl.conf

  • ${XDG_CONFIG_HOME}/gallery-dl/config.json

  • ${HOME}/.config/gallery-dl/config.json

  • ${HOME}/.gallery-dl.conf

When run as executable, gallery-dl will also look for a gallery-dl.conf file in the same directory as said executable.

It is possible to use more than one configuration file at a time. In this case, any values from files after the first will get merged into the already loaded settings and potentially 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 nijie and optional for aryion, danbooru, e621, exhentai, idolcomplex, imgbb, inkbunny, mangadex, mangoxo, pillowfort, sankaku, subscribestar, tapas, tsumino, twitter, and zerochan.

You can set the necessary information in your configuration file

    "extractor": {
        "twitter": {
            "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"


For sites where login with username & password is not possible due to CAPTCHA or similar, or has not been implemented yet, you can use the cookies from a browser login session and input them into gallery-dl.

This can be done via the cookies option in your configuration file by specifying

  • the path to a Mozilla/Netscape format cookies.txt file exported by a browser addon
    (e.g. Export Cookies for Firefox)
  • a list of name-value pairs gathered from your browser’s web developer tools
    (in Chrome, in Firefox)
  • the name of a browser to extract cookies from
    (supported browsers are Chromium-based ones, Firefox, and Safari)

For example:

    "extractor": {
        "instagram": {
            "cookies": "$HOME/path/to/cookies.txt"
        "patreon": {
            "cookies": {
                "session_id": "K1T57EKu19TR49C51CDjOJoXNQLF7VbdVOiBrC9ye0a"
        "twitter": {
            "cookies": ["firefox"]
You can also specify a cookies.txt file with the --cookies command-line option
or a browser to extract cookies from with --cookies-from-browser:
gallery-dl --cookies "$HOME/path/to/cookies.txt" "URL"
gallery-dl --cookies-from-browser firefox "URL"


gallery-dl supports user authentication via OAuth for some extractors. This is necessary for pixiv and optional for deviantart, flickr, reddit, smugmug, tumblr, and mastodon instances.

Linking your account to gallery-dl grants it 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 do so, start by invoking it with oauth:<sitename> 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.

To authenticate with a mastodon instance, run gallery-dl with oauth:mastodon:<instance> as argument. For example:

gallery-dl oauth:mastodon:

Release history Release notifications | RSS feed

Download files

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

Source Distribution

gallery_dl-1.24.5.tar.gz (511.3 kB view hashes)

Uploaded source

Built Distribution

gallery_dl-1.24.5-py3-none-any.whl (581.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page