Gallery-dl

https://gdl-org.github.io/docs
Admin
Gallery-dl is a command-line program to download images and videos from various online galleries and...
Tokens:30,731
Snippets:437
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure exec.command examples

Source: https://gdl-org.github.io/docs/configuration.html

Examples of defining commands as a single shell string or a list of arguments.

```text
"convert {} {}.png && rm {}"
```

```text
["echo", "{user[account]}", "{id}"]
```

--------------------------------

### Example Keywords Configuration

Source: https://gdl-org.github.io/docs/configuration.html

Example of defining additional name-value pairs for metadata dictionaries.

```json
{"type": "Pixel Art", "type_id": 123}
```

--------------------------------

### E621 Metadata Configuration Examples

Source: https://gdl-org.github.io/docs/configuration.html

Examples for configuring additional metadata extraction.

```json
"notes,pools"
```

```json
["notes", "pools"]
```

--------------------------------

### Example Global Keywords Configuration

Source: https://gdl-org.github.io/docs/configuration.html

Example of defining global name-value pairs for metadata dictionaries.

```json
{"type": "Original", "type_id": 1, "type_category": "meta"}
```

--------------------------------

### Example Postprocessor Configuration

Source: https://gdl-org.github.io/docs/configuration.html

Demonstrates the structure of a postprocessor configuration object.

```json
{
    "name"   : "exec",
    "async"  : false,
    "command": "...",
    "event"  : "after"
}
```

--------------------------------

### Configure metadata path

Source: https://gdl-org.github.io/docs/configuration.html

Example path name for metadata insertion.

```text
_meta_path
```

--------------------------------

### Configure exec.commands list

Source: https://gdl-org.github.io/docs/configuration.html

Example of defining multiple commands to run in sequence.

```json
[
    ["echo", "{user[account]}", "{id}"]
    ["magick", "convert" "{_path}",  "\fF {_path.rpartition('.')[0]}.png"],
    "rm {}",
]
```

--------------------------------

### Configure metadata directory

Source: https://gdl-org.github.io/docs/configuration.html

Examples of directory paths for metadata storage.

```text
"metadata"
```

```text
["..", "metadata", "\fF {id // 500 * 500}"]
```

--------------------------------

### Configure FFmpeg arguments

Source: https://gdl-org.github.io/docs/configuration.html

Example of providing additional command-line arguments for FFmpeg.

```json
["-c:v", "libvpx-vp9", "-an", "-b:v", "2M"]
```

--------------------------------

### Basic Replacement Field Examples

Source: https://gdl-org.github.io/docs/formatting.html

Common examples of simple replacement fields.

```text
{title}
```

```text
{content!W}
```

```text
{date:Olocal/%Y%m%d %H%M}
```

--------------------------------

### Define Actions

Source: https://gdl-org.github.io/docs/configuration.html

Examples of action strings and lists of actions to be executed.

```text
"exit"
```

```text
"print Hello World"
```

```text
"raise AbortExtraction an error occured"
```

```text
"flag file = terminate"
```

```text
"keyword title Hello World"
```

```text
["print Exiting", "exit 1"]
```

--------------------------------

### Configure base-directory paths

Source: https://gdl-org.github.io/docs/configuration.html

Examples of setting a simple path or a conditional mapping object for download destinations.

```json
"~/Downloads/gallery-dl"
```

```json
{
    "score >= 100": "$DL",
    "duration"    : "$DL/video",
    ""            : "/tmp/files/"
}
```

--------------------------------

### Configure metadata inclusion

Source: https://gdl-org.github.io/docs/configuration.html

Example list of keys to include in JSON metadata.

```text
["id", "width", "height", "description"]
```

--------------------------------

### Configure hash.hashes algorithms

Source: https://gdl-org.github.io/docs/configuration.html

Examples of defining hash algorithms using string or object formats.

```text
"sha256:hash_sha,sha3_512:hash_sha3"
```

```json
{
    "hash_sha" : "sha256",
    "hash_sha3": "sha3_512"
}
```

--------------------------------

### Configure metadata events

Source: https://gdl-org.github.io/docs/configuration.html

Examples of event triggers for writing metadata.

```text
"prepare,file,after"
```

```text
["prepare-after", "skip"]
```

--------------------------------

### DeviantArt Avatar Formats Example

Source: https://gdl-org.github.io/docs/configuration.html

Example configuration for specifying avatar URL formats.

```json
["original.jpg", "big.jpg", "big.gif", ".png"]
```

--------------------------------

### Configure metadata filename

Source: https://gdl-org.github.io/docs/configuration.html

Example format string for generating metadata filenames.

```text
{id}.data.json
```

--------------------------------

### Configure Filename Format Strings

Source: https://gdl-org.github.io/docs/configuration.html

Examples of simple format strings and conditional objects for generating filenames.

```json
"{manga}_c{chapter}_{page:>03}.{extension}"
```

```json
{
    "extension == 'mp4'": "{id}_video.{extension}",
    "'nature' in title" : "{id}_{title}.{extension}",
    ""                  : "{id}_default.{extension}"
}
```

--------------------------------

### Configure Directory Path Format Strings

Source: https://gdl-org.github.io/docs/configuration.html

Examples of list-based path segments and conditional objects for directory generation.

```json
["{category}", "{manga}", "c{chapter} - {title}"]
```

```json
{
    "'nature' in content": ["Nature Pictures"],
    "retweet_id != 0"    : ["{category}", "{user[name]}", "Retweets"],
    ""                   : ["{category}", "{user[name]}"]
}
```

--------------------------------

### Configure metadata extension format

Source: https://gdl-org.github.io/docs/configuration.html

Examples of format strings for metadata file extensions.

```text
"{extension}.json"
```

```text
"json"
```

--------------------------------

### Configure mkvmerge arguments

Source: https://gdl-org.github.io/docs/configuration.html

Example of providing additional command-line arguments for mkvmerge.

```json
["--no-date", "--disable-lacing"]
```

--------------------------------

### Configure metadata content format

Source: https://gdl-org.github.io/docs/configuration.html

Examples of format strings for custom metadata content.

```text
"tags:\n\n{tags:J\n}\n"
```

```text
["tags:", "", "{tags:J\n}"]
```

--------------------------------

### Logging Configuration Examples

Source: https://gdl-org.github.io/docs/configuration.html

JSON objects defining logging output behavior, including file paths, formatting, and log levels.

```json
{
    "format"     : "{asctime} {name}: {message}",
    "format-date": "%H:%M:%S",
    "path"       : "~/log.txt",
    "encoding"   : "ascii",
    "defer"      : true
}
```

```json
{
    "level" : "debug",
    "format": {
        "debug"  : "debug: {message}",
        "info"   : "[{name}] {message}",
        "warning": "Warning: {message}",
        "error"  : "ERROR: {message}"
    }
}
```

--------------------------------

### Define Postprocessor Configurations

Source: https://gdl-org.github.io/docs/configuration.html

Examples of defining postprocessor objects with various options like filters, whitelists, and specific modes.

```json
{ "name": "mtime" }
```

```json
{
    "name"  : "metadata/print@prepare",
    "format": "{id}: {date}"
}
```

```json
{
    "name"       : "zip",
    "compression": "store",
    "extension"  : "cbz",
    "filter"     : "extension not in ('zip', 'rar')",
    "whitelist"  : ["mangadex", "exhentai", "nhentai"]
}
```

--------------------------------

### Specify output.mode start format with length

Source: https://gdl-org.github.io/docs/configuration.html

Include the printable character count for output shortening calculations.

```json
"start"  : [12, "Downloading {}"]
```

--------------------------------

### Configure metadata fields

Source: https://gdl-org.github.io/docs/configuration.html

Examples for modifying or deleting specific metadata fields.

```json
["blocked", "watching", "status[creator][name]"]
```

```json
{
    "blocked"         : "***",
    "watching"        : "\fE 'yes' if watching else 'no'",
    "status[username]": "{status[creator][name]!l}"
}
```

--------------------------------

### Define Format Strings

Source: https://gdl-org.github.io/docs/configuration.html

Examples of format strings using curly braces for metadata replacement.

```text
"foo"
```

```text
"{username}"
```

```text
"{title} ({id}).{extension}"
```

```text
"\fF {title.title()} ({num:>0{len(str(count))}} / {count}).{extension}"
```

--------------------------------

### Define follow URLs

Source: https://gdl-org.github.io/docs/configuration.html

Examples of format strings or lists of format strings used to process child extractors.

```json
"{content}"
```

```json
"E body or html or text"
```

```json
["{body}", "{html}", "{text}"]
```

--------------------------------

### Configure cookie sources

Source: https://gdl-org.github.io/docs/configuration.html

Examples of defining cookie sources using file paths, key-value objects, or browser profiles.

```json
"~/.local/share/cookies-instagram-com.txt"
```

```json
{
    "cookie-name": "cookie-value",
    "sessionid"  : "14313336321%3AsabDFvuASDnlpb%3A31",
    "isAdult"    : "1"
}
```

```json
["firefox"]
["firefox", null, null, "Personal"]
["chromium", "Private", "kwallet", null, ".twitter.com"]
```

--------------------------------

### Define metadata fields

Source: https://gdl-org.github.io/docs/configuration.html

Examples of specifying Python modules and functions for metadata processing.

```text
"my_module:generate_text"
"~/.local/share/gdl_utils.py:resize"
```

--------------------------------

### Configure path-restrict characters

Source: https://gdl-org.github.io/docs/configuration.html

Examples of defining character replacement rules for generated path segments.

```json
"/!? (){}"
```

```json
{"/": "_", "+": "_＋_", "({[": "(", "]})": ")", "a-z": "*"}
```

--------------------------------

### Configure cookie selection

Source: https://gdl-org.github.io/docs/configuration.html

Example of providing a list of cookie sources for selection during extractor runs.

```json
[
    "~/.local/share/cookies-instagram-com-1.txt",
    "~/.local/share/cookies-instagram-com-2.txt",
    "~/.local/share/cookies-instagram-com-3.txt",
    ["firefox", null, null, "c1", ".instagram-com"],
]
```

--------------------------------

### Access Metadata with Field Names

Source: https://gdl-org.github.io/docs/formatting.html

Examples of accessing metadata using various field name techniques.

```text
{title}
```

```text
{title[6]}
```

```text
{title[3:8]}
```

```text
{title_ja[b3:18]}
```

```text
{empty|title}
```

```text
{extractor.url}
```

```text
{user[name]}
```

```text
{user['name']}
```

```text
{title[24]|empty|extractor.url[15:-1]}
```

--------------------------------

### General Command-Line Options

Source: https://gdl-org.github.io/docs/options.html

Standard flags for help, versioning, file naming, and directory configuration.

```text
-h, --help                  Print this help message and exit
--version                   Print program version and exit
-f, --filename FORMAT       Filename format string for downloaded files
                            ('/O' for "original" filenames)
-d, --destination PATH      Target location for file downloads
-D, --directory PATH        Exact location for file downloads
--restrict-filenames VALUE  Replace restricted filename characters with
                            underscores. One of 'windows', 'windows+',
                            'unix', 'ascii', 'ascii+', or a custom set of
                            characters
--windows-filenames         Force filenames to be Windows-compatible
-X, --extractors PATH       Load external extractors from PATH
--compat                    Restore legacy 'category' names
-S, --server                Enable server mode. Send input URLs to a
                            gallery-dl server or create an IPC server when
                            no input URLs are given
```

--------------------------------

### Define Conditions

Source: https://gdl-org.github.io/docs/configuration.html

Examples of boolean-evaluated expressions used as conditions.

```python
"not is_watching"
```

```python
"locals().get('optional')"
```

```python
"date >= datetime(2025, 7, 1) or abort()"
```

```python
["width > 800", "0.9 < width/height < 1.1"]
```

--------------------------------

### Define Subconfigurations

Source: https://gdl-org.github.io/docs/configuration.html

List additional configuration files to be loaded.

```json
["~/cfg-twitter.json", "~/cfg-reddit.json"]
```

--------------------------------

### Define Python Expressions

Source: https://gdl-org.github.io/docs/configuration.html

Examples of Python expressions used for dynamic evaluation.

```python
"1 + 2 + 3"
```

```python
"str(id) + '_' + title"
```

```python
"' - '.join(tags[:3]) if tags else 'no tags'"
```

--------------------------------

### Configure postprocessor options

Source: https://gdl-org.github.io/docs/configuration.html

Set additional options for post-processors before initialization.

```json
{
    "archive": null,
    "keep-files": true
}
```

--------------------------------

### Configure metadata exclusion

Source: https://gdl-org.github.io/docs/configuration.html

Example list of keys to exclude from JSON metadata.

```text
["blocked", "watching", "status"]
```

--------------------------------

### Configure gallery-dl settings

Source: https://gdl-org.github.io/docs/gallery-dl.conf

Defines logging, color output, and server connection parameters in JSON format.

```json
        "stdin"    : null,
        "stdout"   : null,
        "stderr"   : null,

        "log"      : "[{name}][{levelname}] {message}",
        "logfile"  : null,
        "errorfile": null,
        "unsupportedfile": null,

        "colors"   :
        {
            "success": "1;32",
            "skip"   : "2",
            "debug"  : "0;37",
            "info"   : "1;37",
            "warning": "1;33",
            "error"  : "1;31"
        }
    },

    "#": "===================================================================",
    "#": "====    Server Options    =========================================",

    "server":
    {
        "host"   : "127.0.0.1",
        "port"   : 64696,
        "key"    : "gallery_dl",
        "enabled": false,
        "timeout": 10
    }
}
```

--------------------------------

### Define internal modules

Source: https://gdl-org.github.io/docs/configuration.html

List specific internal modules to load to optimize startup time and memory usage.

```json
["reddit", "danbooru", "mangadex"]
```

--------------------------------

### Getting current date and time

Source: https://gdl-org.github.io/docs/formatting.html

Format the current local date and time.

```python
{_now:%Y-%m}
```

--------------------------------

### Configure postprocessors

Source: https://gdl-org.github.io/docs/configuration.html

Define a list of post-processors to be applied to downloaded files in order.

```json
[
    {
        "name": "zip" ,
        "compression": "store"
    },
    {
        "name": "exec",
        "command": ["/home/foobar/script", "{category}", "{image_id}"]
    }
]
```

--------------------------------

### Apply Conversion Specifiers

Source: https://gdl-org.github.io/docs/formatting.html

Examples of using single-character conversion specifiers to transform values.

```text
{foo!l}
```

```text
{foo!u}
```

```text
{foo!c}
```

```text
{foo!C}
```

```text
{foo!g}
```

```text
{tags!j}
```

```text
{lang!L}
```

```text
{foo!n}
```

```text
{space!W}
```

```text
{bar!t}
```

```text
{date!T}
```

```text
{created!d}
```

```text
{created!D}
```

```text
{jpn!q}
```

```text
{jpn_url!Q}
```

```text
{html!U}
```

```text
{html!H}
```

```text
{lorem!R}
```

```text
{tags!s}
```

```text
{tags!S}
```

--------------------------------

### Configure part file directory

Source: https://gdl-org.github.io/docs/configuration.html

Set alternate locations for .part files, optionally using conditions based on file attributes.

```json
"/tmp/.gdl"
```

```json
{
    "size > 100000": "~/.gdl/part",
    "duration"     : "/tmp/.gdl/video",
}
```

--------------------------------

### Configure YoutubeDL raw options

Source: https://gdl-org.github.io/docs/configuration.html

Pass additional options directly to the YoutubeDL constructor.

```json
{
    "quiet": true,
    "writesubtitles": true,
    "merge_output_format": "mkv"
}
```

--------------------------------

### List available hash algorithms

Source: https://gdl-org.github.io/docs/configuration.html

Command to list all available hash algorithms supported by the system's hashlib.

```bash
python -c "import hashlib; print('\n'.join(hashlib.algorithms_available))"
```

--------------------------------

### Forward parent metadata

Source: https://gdl-org.github.io/docs/configuration.html

Example of mapping parent metadata to a specific field in child extractors.

```json
{
    "id": "child-id",
    "_p_": {"id": "parent-id"}
}
```

--------------------------------

### Using template file with format string

Source: https://gdl-org.github.io/docs/formatting.html

Specify a path to a template file containing a regular format string.

```python
\fT ~/.templates/booru.txt
```

--------------------------------

### Output Configuration Options

Source: https://gdl-org.github.io/docs/gallery-dl.conf

Settings for controlling the console output, progress reporting, and file naming conventions.

```json
"output":
    {
        "ansi"     : true,
        "fallback" : true,
        "jsonl"    : false,
        "mode"     : "auto",
        "private"  : false,
        "progress" : true,
        "shorten"  : true,
        "skip"     : true,
        "units"    : "decimal",
```

--------------------------------

### Configure Jinja environment

Source: https://gdl-org.github.io/docs/configuration.html

Set initialization parameters for the Jinja Environment object.

```json
{
    "variable_start_string": "(((",
    "variable_end_string"  : ")))",
    "keep_trailing_newline": true
}
```

--------------------------------

### Define custom output.mode format strings

Source: https://gdl-org.github.io/docs/configuration.html

Replicate standard output modes by providing a custom object with specific format keys.

```json
{
    "start"  : "{}",
    "success": "\r\u001b[1;32m{}\u001b[0m\n",
    "skip"   : "\u001b[2m{}\u001b[0m\n",
    "progress"      : "\r{0:>7}B {1:>7}B/s ",
    "progress-total": "\r{3:>3}% {0:>7}B {1:>7}B/s "
}
```

--------------------------------

### Define Input Files

Source: https://gdl-org.github.io/docs/configuration.html

Specify additional input files for the application.

```json
["~/urls.txt", "$HOME/input"]
```

--------------------------------

### Configure Downloader Settings

Source: https://gdl-org.github.io/docs/gallery-dl-example.conf

Sets global download behavior such as rate limiting, retries, and module selection.

```json
"downloader":
    {
        "#": "restrict download speed to 1 MB/s",
        "rate": "1M",

        "#": "show download progress indicator after 2 seconds",
        "progress": 2.0,

        "#": "retry failed downloads up to 3 times",
        "retries": 3,

        "#": "consider a download 'failed' after 8 seconds of inactivity",
        "timeout": 8.0,

        "#": "write '.part' files into a special directory",
        "part-directory": "/tmp/.download/",

        "#": "do not update file modification times",
        "mtime": false,

        "ytdl":
        {
            "#": "use yt-dlp instead of youtube-dl",
            "module": "yt_dlp"
        }
    }
```

--------------------------------

### Site-specific Configuration Blocks

Source: https://gdl-org.github.io/docs/gallery-dl.conf

Configuration settings for various platforms including authentication, metadata, and download behavior.

```json
"modules": ["image", "video", "mediacollection", "embed"]
        },
        "bellazon":
        {
            "order-posts": "desc",
            "quoted"     : false
        },
        "bilibili":
        {
            "sleep-request": "3.0-6.0",

            "livephoto": true
        },
        "bluesky":
        {
            "username": "",
            "password": "",

            "api-server": null,
            "include"   : ["media"],
            "metadata"  : false,
            "quoted"    : false,
            "reposts"   : false,
            "videos"    : true,

            "likes": {
                "depth"   : 0,
                "endpoint": "listRecords"
            },
            "post": {
                "depth": 0
            }
        },
        "boosty":
        {
            "allowed" : true,
            "bought"  : false,
            "metadata": false,
            "videos"  : true
        },
        "booth":
        {
            "sleep-request": "0.5-1.5",

            "strategy": "webpage"
        },
        "bunkr":
        {
            "endpoint": "/api/_001_v2",
            "tlds": false
        },
        "cien":
        {
            "sleep-request": "1.0-2.0",
            "files": ["image", "video", "download", "gallery"]
        },
        "civitai":
        {
            "api-key": null,
            "sleep-request": "0.5-1.5",

            "api"     : "trpc",
            "files"   : ["image"],
            "include" : ["user-images", "user-videos"],
            "metadata": false,
            "nsfw"    : true,
            "period"  : "AllTime",
            "sort"    : "Newest",
            "quality" : "original=true",
            "quality-videos": "original"
        },
        "clonr":
        {
            "zip": false
        },
        "coomer":
        {
            "username": "",
            "password": "",

            "announcements": false,
            "comments"     : false,
            "dms"          : false,
            "duplicates"   : false,
            "favorites"    : "artist",
            "files"        : ["file", "attachments", "inline"],
            "max-posts"    : null,
            "metadata"     : false,
            "original"     : false,
            "revisions"    : false,
            "order-revisions": "desc"
        },
        "cosmos":
        {
            "format": "jpeg"
        },
        "cyberdrop":
        {
            "domain": null
        },
        "cyberfile":
        {
            "password" : "",
            "recursive": true
        },
        "dankefuerslesen":
        {
            "zip": false
        },
        "deviantart":
        {
            "client-id"    : null,
            "client-secret": null,
            "refresh-token": null,

            "auto-watch"      : false,
            "auto-unwatch"    : false,
            "comments"        : false,
            "comments-avatars": false,
            "extra"           : false,
            "flat"            : true,
            "folders"         : false,
            "group"           : true,
            "include"         : "gallery",
            "intermediary"    : true,
            "journals"        : "html",
            "jwt"             : false,
            "mature"          : true,
            "metadata"        : false,
            "original"        : false,
            "pagination"      : "api",
            "previews"        : false,
            "public"          : true,
            "quality"         : 100,
            "wait-min"        : 0,

            "avatar": {
                "formats": null
            },
            "folder": {
                "subfolders": true
            }
        },
        "discord":
        {
            "embeds" : ["image", "gifv", "video"],
            "threads": true,
            "token"  : ""
        },
        "dynastyscans":
        {
            "anthology": {
                "metadata": false
            }
        },
        "erome":
        {
            "user": {
                "parent" : true,
                "reposts": false
            }
        },
        "exhentai":
        {
            "username": "",
            "password": "",
            "cookies" : null,
            "sleep-request": "3.0-6.0",

            "domain"  : "auto",
            "fav"     : null,
            "gp"      : "resized",
            "metadata": false,
            "original": true,
            "source"  : null,
            "tags"    : true,
            "limits"  : null,
            "limits-action"   : "stop",
            "fallback-retries": 2
        },
        "facebook":
        {
            "cookies": null,

            "author-followups": false,
            "include": "photos",
            "loop"   : true,
            "videos" : true
        },
        "fanbox":
        {
            "cookies" : null
```

--------------------------------

### Configure Output and Logging

Source: https://gdl-org.github.io/docs/gallery-dl-example.conf

Defines logging levels, ANSI formatting, and file output paths for logs and unsupported URLs.

```json
"output":
    {
        "log": {
            "level": "info",

            "#": "use different ANSI colors for each log level",
            "format": {
                "debug"  : "\u001b[0;37m{name}: {message}\u001b[0m",
                "info"   : "\u001b[1;37m{name}: {message}\u001b[0m",
                "warning": "\u001b[1;33m{name}: {message}\u001b[0m",
                "error"  : "\u001b[1;31m{name}: {message}\u001b[0m"
            }
        },

        "#": "shorten filenames to fit into one terminal line",
        "#": "while also considering wider East-Asian characters",
        "shorten": "eaw",

        "#": "enable ANSI escape sequences on Windows",
        "ansi": true,

        "#": "write logging messages to a separate file",
        "logfile": {
            "path": "~/gallery-dl/log.txt",
            "mode": "w",
            "level": "debug"
        },

        "#": "write unrecognized URLs to a separate file",
        "unsupportedfile": {
            "path": "~/gallery-dl/unsupported.txt",
            "mode": "a",
            "format": "{asctime} {message}",
            "format-date": "%Y-%m-%d-%H-%M-%S"
        }
    }
```

--------------------------------

### Downloader Configuration Options

Source: https://gdl-org.github.io/docs/gallery-dl.conf

Global settings for file downloading, including proxy, retries, and specific HTTP/ytdl module configurations.

```json
"downloader":
    {
        "filesize-min"  : null,
        "filesize-max"  : null,
        "mtime"         : true,
        "part"          : true,
        "part-directory": null,
        "progress"      : 3.0,
        "proxy"         : null,
        "rate"          : null,
        "retries"       : 4,
        "timeout"       : 30.0,
        "verify"        : true,

        "http":
        {
            "adjust-extensions": true,
            "chunk-size"       : 32768,
            "consume-content"  : false,
            "enabled"          : true,
            "headers"          : null,
            "retry-codes"      : [],
            "sleep-429"        : 60.0,
            "validate"         : true,
            "validate-html"    : true
        },

        "ytdl":
        {
            "cmdline-args"   : null,
            "config-file"    : null,
            "deprecations"   : false,
            "enabled"        : true,
            "format"         : null,
            "forward-cookies": true,
            "logging"        : true,
            "module"         : null,
            "outtmpl"        : null,
            "raw-options"    : null
        }
    },
```

--------------------------------

### Inherit Postprocessor Presets

Source: https://gdl-org.github.io/docs/configuration.html

Demonstrates inheriting options from a global postprocessor preset using the type attribute.

```json
{
    "extractor": {
        "postprocessors": {
            "#": "inherit from 'jl' preset",
            "type": "jl",
            "filename": "meta.jsonl"
        }
    },

    "postprocessor": {
        "jl": {
            "name": "metadata/jsonl",
            "open": "a"
        }
    }
}
```

--------------------------------

### Configure output streams

Source: https://gdl-org.github.io/docs/configuration.html

Reconfigure standard streams using either a simple encoding string or a detailed configuration object.

```json
"utf-8"
```

```json
{
    "encoding": "utf-8",
    "errors": "replace",
    "line_buffering": true
}
```

--------------------------------

### Update Command-Line Options

Source: https://gdl-org.github.io/docs/options.html

Flags for managing software updates and release channels.

```text
-U, --update                Update to the latest version
--update-to CHANNEL[@TAG]   Switch to a dfferent release channel (stable or
                            dev) or upgrade/downgrade to a specific version
--update-check              Check if a newer version is available
```

--------------------------------

### Post-processing Command-line Options

Source: https://gdl-org.github.io/docs/options.html

List of available flags for configuring post-processing behavior, including metadata handling, archiving, and file execution.

```bash
-P, --postprocessor NAME    Activate the specified post processor
--no-postprocessors         Do not run any post processors
-O, --postprocessor-option KEY=VALUE
                            Additional post processor options
--write-metadata            Write metadata to separate JSON files
--write-info-json           Write gallery metadata to a info.json file
--write-tags                Write image tags to separate text files
--zip                       Store downloaded files in a ZIP archive
--cbz                       Store downloaded files in a CBZ archive
--mtime NAME                Set file modification times according to
                            metadata selected by NAME. Examples: 'date' or
                            'status[date]'
--rename FORMAT             Rename previously downloaded files from FORMAT
                            to the current filename format
--rename-to FORMAT          Rename previously downloaded files from the
                            current filename format to FORMAT
--ugoira FMT                Convert Pixiv Ugoira to FMT using FFmpeg.
                            Supported formats are 'webm', 'mp4', 'gif',
                            'vp8', 'vp9', 'vp9-lossless', 'copy', 'zip'.
--exec CMD                  Execute CMD for each downloaded file. Supported
                            replacement fields are {} or {_path},
                            {_temppath}, {_directory}, {_filename}. On
                            Windows, use {_path_unc} or {_directory_unc}
                            for UNC paths. Example: --exec "convert {}
                            {}.png && rm {}"
--exec-after CMD            Execute CMD after all files were downloaded.
                            Example: --exec-after "cd {_directory} &&
                            convert * ../doc.pdf"
```

--------------------------------

### Override Configuration with Global Settings

Source: https://gdl-org.github.io/docs/configuration.html

Shows how to define a global setting that overrides all other extractor-level values.

```json
{
    "extractor": {
        "<option-name>": "<value-base (overridden)>"
    },
    "<option-name>": "<value-global>"
}
```

--------------------------------

### Set downloader file size limits

Source: https://gdl-org.github.io/docs/configuration.html

Define minimum or maximum file sizes in bytes using integer or float values with optional suffixes.

```json
"32000", "500k", "2.5M"
```

--------------------------------

### Configure file ranges

Source: https://gdl-org.github.io/docs/configuration.html

Define index ranges to select specific files for download.

```json
"10-20"
```

```json
"-5, 10, 30-50, 100-"
```

```json
"10:21, 30:51:2, :5, 100:"
```

```json
["-5", "10", "30-50", "100-"]
```
Tokens:
Raw