About this project

gallery-dl is a command-line program designed to download image galleries and collections from a wide range of image hosting sites. It is a cross-platform tool that supports Windows, Linux, and macOS, and is written in Python (requiring Python 3.8+ and the Requests library). Key features include: - **Multi-site support**: Extractors for numerous image hosting platforms, including danbooru, Twitter, Pixiv, MangaDex, Tumblr, Instagram, Patreon, Flickr, Reddit, DeviantArt, and many more. A full list of supported sites is maintained in the project documentation. - **Extensive configuration**: JSON-based configuration files with a large set of options covering download behavior, file naming, authentication, cookies, and more. Multiple configuration files can be merged, with later files overriding earlier ones. Configuration files are searched in platform-specific locations (e.g., %APPDATA% on Windows, ~/.config/gallery-dl/ on Linux/macOS). - **Powerful file-naming**: Flexible formatting capabilities for organizing downloaded files with custom naming patterns. - **Authentication support**: Multiple authentication methods including username/password pairs, browser cookie extraction (from Chromium-based browsers, Firefox, and Safari), and OAuth for sites like Pixiv, Flickr, Reddit, DeviantArt, and Mastodon instances. - **Filtering and options**: Command-line options for filtering content (e.g., by chapter number and language), forcing specific extractors, and searching remote resources for URLs. - **Video support**: Optional integration with yt-dlp or youtube-dl for HLS/DASH video downloads, and FFmpeg for Pixiv Ugoira conversion. - **Multiple installation methods**: Available via pip (PyPI), standalone executables for Windows and Linux, Snap, Chocolatey, Scoop, Homebrew, MacPorts, Docker (Docker Hub and GitHub Container Registry), and Nix/Home Manager. - **Archive support**: Optional PostgreSQL archive support via Psycopg for tracking already-downloaded items. - **Proxy and compression**: Optional SOCKS proxy support via PySocks, Brotli compression via brotli/brotlicffi, and Zstandard compression via zstandard. The tool is invoked by passing URLs as arguments: `gallery-dl [OPTIONS]... URLS...`. It also supports a remote URL search mode (prefixing with `r:`) to find and download images from URLs listed in a remote resource. Extractor names can be prefixed to URLs to force a specific extractor when the site address is nonstandard. Active development has moved to Codeberg, with the project hosted at https://codeberg.org/mikf/gallery-dl.