Package: gallery-dl
gallery-dlis a command-line program
to download image galleries and collections
from several image hosting sites
(seeSupported Sites).
It is a cross-platform tool
with manyconfiguration optionsand powerfulfilenaming capabilities.ContentsDependenciesOptionalInstallationPipStandalone ExecutableNightly BuildsSnapChocolateyScoopHomebrewMacPortsDockerUsageExamplesConfigurationDocumentationLocationsAuthenticationUsername & PasswordCookiesOAuthDependenciesPython3.4+RequestsOptionalFFmpeg: Pixiv Ugoira conversionyt-dlporyoutube-dl: Video downloadsPySocks: SOCKS proxy supportbrotliorbrotlicffi: Brotli compression supportPyYAML: YAML configuration file supporttoml: TOML configuration file support for Python<3.11SecretStorage: GNOME keyring passwords for--cookies-from-browserInstallationPipThe stable releases ofgallery-dlare distributed onPyPIand can be
easily installed or upgraded usingpip:python3-mpipinstall-Ugallery-dlInstalling the latest dev version directly from GitHub can be done withpipas well:python3-mpipinstall-U-I--no-deps--no-cache-dirhttps://github.com/mikf/gallery-dl/archive/master.tar.gzNote: Windows users should usepy -3instead ofpython3.It is advised to use the latest version ofpip,
including the essential packagessetuptoolsandwheel.
To ensure these packages are up-to-date, runpython3-mpipinstall--upgradepipsetuptoolswheelStandalone ExecutablePrebuilt executable files with a Python interpreter and
required Python packages included are available forWindows(RequiresMicrosoft Visual C++ Redistributable Package (x86))LinuxNightly BuildsExecutables build from the latest commit can be found athttps://github.com/mikf/gallery-dl/actions/workflows/executables.ymlSnapLinux users that are using a distro that is supported bySnapdcan installgallery-dlfrom the Snap Store:snapinstallgallery-dlChocolateyWindows users that haveChocolateyinstalled can installgallery-dlfrom the Chocolatey Community Packages repository:chocoinstallgallery-dlScoopgallery-dlis also available in theScoop“main” bucket for Windows users:scoopinstallgallery-dlHomebrewFor macOS or Linux users using Homebrew:brewinstallgallery-dlMacPortsFor macOS users with MacPorts:sudoportinstallgallery-dlDockerUsing the Dockerfile in the repository:gitclonehttps://github.com/mikf/gallery-dl.gitcdgallery-dl/dockerbuild-tgallery-dl:latest.Pulling image fromDocker Hub:dockerpullmikf123/gallery-dldockertagmikf123/gallery-dlgallery-dlPulling image fromGitHub Container Registry:dockerpullghcr.io/mikf/gallery-dldockertagghcr.io/mikf/gallery-dlgallery-dlTo run the container you will probably want to attach some directories on the host so that the config file and downloads can persist across runs.Make sure to either download the example config file reference in the repo and place it in the mounted volume location or touch an empty file there.If you gave the container a different tag or are using podman then make sure you adjust.  Rundocker image lsto check the name if you are not sure.This will remove the container after every use so you will always have a fresh environment for it to run. If you setup a ci-cd pipeline to autobuild the container you can also add a--pull=newerflag so that when you run it docker will check to see if there is a newer container and download it before running.dockerrun--rm-v$HOME/Downloads/:/gallery-dl/-v$HOME/.config/gallery-dl/gallery-dl.conf:/etc/gallery-dl.conf-itgallery-dl:latestYou can also add an alias to your shell for “gallery-dl” or create a simple bash script and drop it somewhere in your $PATH to act as a shim for this command.UsageTo usegallery-dlsimply call it with the URLs you wish to download images
from:gallery-dl[OPTIONS]...URLS...Usegallery-dl --helpor seehttps://github.com/mikf/gallery-dl/blob/master/docs/options.mdfor a full list of all command-line options.ExamplesDownload images; in this case from danbooru via tag search for ‘bonocho’:gallery-dl"https://danbooru.donmai.us/posts?tags=bonocho"Get the direct URL of an image from a site supporting authentication with username & password:gallery-dl-g-u"<username>"-p"<password>""https://twitter.com/i/web/status/604341487988576256"Filter manga chapters by chapter number and language:gallery-dl--chapter-filter"10 <= chapter < 20"-o"lang=fr""https://mangadex.org/title/59793dd0-a2d8-41a2-9758-8197287a8539"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"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"ConfigurationConfiguration files forgallery-dluse a JSON-based file format.DocumentationA list of all available configuration options and their descriptions
can be found inhttps://github.com/mikf/gallery-dl/blob/master/docs/configuration.rst.For a default configuration file with available options set to their
default values, seehttps://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl.conf.For a commented example with more involved settings and option usage,
seehttps://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl-example.conf.Locationsgallery-dlsearches for configuration files in the following places:Windows:%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.confWhen run asexecutable,gallery-dlwill also look for agallery-dl.conffile
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.AuthenticationUsername & PasswordSome extractors require you to provide valid login credentials in the form of
a username & password pair. This is necessary fornijieand optional foraryion,danbooru,e621,exhentai,idolcomplex,imgbb,inkbunny,mangadex,mangoxo,pillowfort,sankaku,subscribestar,tapas,tsumino,twitter,
andzerochan.You can set the necessary information in yourconfiguration file{"extractor":{"twitter":{"username":"<username>","password":"<password>"}}}or you can provide them directly via the-u/--usernameand-p/--passwordor via the-o/--optioncommand-line optionsgallery-dl-u"<username>"-p"<password>""URL"gallery-dl-o"username=<username>"-o"password=<password>""URL"CookiesFor 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 intogallery-dl.This can be done via thecookiesoption in your configuration file by specifyingthe path to a Mozilla/Netscape format cookies.txt file exported by a browser addon(e.g.Get cookies.txt LOCALLYfor Chrome,Export Cookiesfor Firefox)a list of name-value pairs gathered from your browser’s web developer tools(inChrome,
inFirefox)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--cookiescommand-line optionor a browser to extract cookies from with--cookies-from-browser:gallery-dl--cookies"$HOME/path/to/cookies.txt""URL"gallery-dl--cookies-from-browserfirefox"URL"OAuthgallery-dlsupports user authentication viaOAuthfor some extractors.
This is necessary forpixivand optional fordeviantart,flickr,reddit,smugmug,tumblr,
andmastodoninstances.Linking your account togallery-dlgrants 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 withoauth:<sitename>as an argument.
For example:gallery-dloauth:flickrYou will be sent to the site’s authorization page and asked to grant read
access togallery-dl. Authorize it and you will be shown one or more
“tokens”, which should be added to your configuration file.To authenticate with amastodoninstance, rungallery-dlwithoauth:mastodon:<instance>as argument. For example:gallery-dloauth:mastodon:pawoo.netgallery-dloauth:mastodon:https://mastodon.social/