Scroll to navigation

GALLERY-DL(1) gallery-dl Manual GALLERY-DL(1)

NAME

gallery-dl - download image-galleries and -collections

SYNOPSIS

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

DESCRIPTION

gallery-dl is a command-line program to download image-galleries and -collections from several image hosting sites. It is a cross-platform tool with many configuration options and powerful filenaming capabilities.

OPTIONS

Print this help message and exit
Print program version and exit
Filename format string for downloaded files ('/O' for "original" filenames)
Target location for file downloads
Exact location for file downloads
Load external extractors from PATH
User-Agent request header
Delete cached login sessions, cookies, etc. for MODULE (ALL to delete everything)
Check if a newer version is available
Download URLs found in FILE ('-' for stdin). More than one --input-file can be specified
Download URLs found in FILE. Comment them out after they were downloaded successfully.
Download URLs found in FILE. Delete them after they were downloaded successfully.
Do not prompt for passwords/tokens
Activate quiet mode
Print only warnings and errors
Print various debugging information
Print URLs instead of downloading
Print URLs instead of downloading; resolve intermediary URLs
Print JSON information
Print JSON information; resolve intermediary URLs
Simulate data extraction; do not download anything
Print extractor defaults and settings
Print a list of available keywords and example values for the given URLs
Add input URLs which returned an error to FILE
Write FORMAT during EVENT (default 'prepare') to standard output. Examples: 'id' or 'post:{md5[:8]}'
Append FORMAT during EVENT to FILE
Print a list of available extractor modules
Print a list of extractor classes with description, (sub)category and example URL
Write logging output to FILE
Write URLs, which get emitted by other extractors but cannot be handled, to FILE
Write downloaded intermediary pages to files in the current directory to debug problems
Display sent and read HTTP traffic
Do not emit ANSI color codes in output
Maximum number of retries for failed HTTP requests or -1 for infinite retries (default: 4)
Timeout for HTTP connections (default: 30.0)
Use the specified proxy
Client-side IP address to bind to
-4, --force-ipv4
Make all connections via IPv4
-6, --force-ipv6
Make all connections via IPv6
Disable HTTPS certificate validation
Maximum download rate (e.g. 500k or 2.5M)
Size of in-memory data chunks (default: 32k)
Number of seconds to wait before each download. This can be either a constant value or a range (e.g. 2.7 or 2.0-3.5)
Number of seconds to wait between HTTP requests during data extraction
Number of seconds to wait before starting data extraction for an input URL
Do not use .part files
Do not skip downloads; overwrite existing files
Do not set file modification times according to Last-Modified HTTP response headers
Do not download any files
Additional options. Example: -o browser=firefox
Additional configuration files
Additional configuration files in YAML format
Additional configuration files in TOML format
Create a basic configuration file
Show configuration file status
Open configuration file in external application
Do not read default configuration files
Username to login with
Password belonging to the given username
Enable .netrc authentication data
File to load additional cookies from
Export session cookies to FILE
Name of the browser to load cookies from, with optional domain prefixed with '/', keyring name prefixed with '+', profile prefixed with ':', and container prefixed with '::' ('none' for no container (default), 'all' for all containers)
Stop current extractor run after N consecutive file downloads were skipped
Stop current and parent extractor runs after N consecutive file downloads were skipped
Do not download files smaller than SIZE (e.g. 500k or 2.5M)
Do not download files larger than SIZE (e.g. 500k or 2.5M)
Record all downloaded or skipped files in FILE and skip downloading any file already in it
Index range(s) specifying which files to download. These can be either a constant value, range, or slice (e.g. '5', '8-20', or '1:24:3')
Like '--range', but applies to manga chapters and other delegated URLs
Python expression controlling which files to download. Files for which the expression evaluates to False are ignored. Available keys are the filename-specific ones listed by '-K'. Example: --filter "image_width >= 1000 and rating in ('s', 'q')"
Like '--filter', but applies to manga chapters and other delegated URLs
Activate the specified post processor
Do not run any post processors
Additional post processor options
Write metadata to separate JSON files
Write gallery metadata to a info.json file
Write image tags to separate text files
Store downloaded files in a ZIP archive
Store downloaded files in a CBZ archive
Set file modification times according to metadata selected by NAME. Examples: 'date' or 'status[date]'
Rename previously downloaded files from FORMAT to the current filename format
Rename previously downloaded files from the current filename format to FORMAT
Convert Pixiv Ugoira to FMT using FFmpeg. Supported formats are 'webm', 'mp4', 'gif', 'vp8', 'vp9', 'vp9-lossless', 'copy', 'zip'.
Execute CMD for each downloaded file. Supported replacement fields are {} or {_path}, {_directory}, {_filename}. Example: --exec "convert {} {}.png && rm {}"
Execute CMD after all files were downloaded. Example: --exec-after "cd {_directory} && convert * ../doc.pdf"

EXAMPLES

Download images from URL.
Print direct URLs from a site that requires authentication.
Apply filter and range expressions. This will only download the second, third, and fourth file where its type value is equal to "ugoira".
Scan URL for other URLs and invoke gallery-dl on them.
Gain OAuth authentication tokens for deviantart, flickr, reddit, smugmug, and tumblr.

FILES

/etc/gallery-dl.conf
The system wide configuration file.
~/.config/gallery-dl/config.json
Per user configuration file.
~/.gallery-dl.conf
Alternate per user configuration file.

BUGS

https://github.com/mikf/gallery-dl/issues

AUTHORS

Mike Fährmann <mike_faehrmann@web.de>
and https://github.com/mikf/gallery-dl/graphs/contributors

SEE ALSO

gallery-dl.conf(5)

2025-01-12 1.28.4