Skip to main content

Command-line program to download image galleries and collections from pixiv, exhentai, danbooru, gelbooru, nijie and more

Project description

gallery-dl is a command-line program to download image-galleries and -collections from several image hosting sites such as pixiv.net, exhentai.org, gelbooru.com and several more (see Supported Sites). It requires Python 3.3+ to run and works on Unix-like systems as well as on Windows.

pypi build

1 Installation

1.1 Installation via pip

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

$ pip install gallery-dl

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

$ pip install https://github.com/mikf/gallery-dl/archive/master.zip

1.2 Manual installation via Python

Get the code by downloading either the stable or dev archives and unpacking them, or via git clone. Navigate into the respective directory and run the setup.py file.

$ git clone https://github.com/mikf/gallery-dl.git
$ cd gallery-dl
$ python setup.py install

1.3 Standalone executable (Windows only)

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,

2 Usage

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.

2.1 Examples

Download images from gelbooru found via tag search for ‘bonocho’:

$ gallery-dl "http://gelbooru.com/index.php?page=post&s=list&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

3 Supported Sites

  • pixiv.net

  • seiga.nicovideo.jp

  • nijie.info

  • bato.to

  • 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

4 Configuration

Configuration files for gallery-dl use a JSON-based file format. For a (more or less) complete example, see gallery-dl.conf.

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

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 users home directory, i.e. C:\Users\<username>\)

Values in later configuration files will override previous ones.

5 Authentication

Some extractors require you to provide valid login-credentials. This currently includes pixiv, exhentai, nijie, seiga and batoto.

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

Project details


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-0.8.4.tar.gz (78.0 kB view hashes)

Uploaded Source

Built Distribution

gallery_dl-0.8.4-py3-none-any.whl (129.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page