E621 reverse image

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

Optional

Installation

Pip

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

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

Note: Windows users should use instead of .

From Source

Get the code by either

• Downloading a stable or dev archive and unpacking it
• Or via

Navigate into the respective directory and run the file.

Standalone Executable

Download a standalone executable file, put it into your PATH, and run it inside a command prompt (like ).

These executables include a Python interpreter and all required Python packages.

Snap

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

Chocolatey

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

Scoop

Apart from Chocolatey, gallery-dl is also available in Scoop "main" bucket for Windows users.

Usage

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

See also .

Examples

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

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

Filter manga chapters by language and chapter number:

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:

Configuration

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

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

Windows:

( usually refers to the user's home directory, i.e. )

Linux, macOS, etc.:

Values in later configuration files will override previous ones.

Command line options will override all related settings in the configuration file(s), e.g. using will enable writing metadata using the default values for all settings, overriding any specific settings in configuration files.

Authentication

Username & Password

Some extractors require you to provide valid login credentials in the form of a username & password pair. This is necessary for , , and and optional for , , , , , , , , , , , , and .

You can set the necessary information in your configuration file (cf. gallery-dl.conf)

or you can provide them directly via the and or via the command-line options

Cookies

gallery-dl.

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

• a list of name-value pairs gathered from your browser's web developer tools

  (in Chrome, in Firefox)

For example:

You can also specify a cookies.txt file with the command-line option:

OAuth

gallery-dl supports user authentication via OAuth for , , , and . 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 as an argument. For example:

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.