Command-line Interface (CLI) options¶
Global options¶
- URL¶
MangaDex URL or a file containing MangaDex URLs. This parameter also can be used for commands, to see all available commands see Commands
- --type -t manga|cover|list|chapter|legacy-manga|legacy-chapter¶
Override type MangaDex url. By default, it auto detect given url
- --replace -r¶
Replace manga if exist
- --filter -ft FILTERS¶
Apply filter to search and random manga. For more information, you can see Filters
- --download-mode -dm default|unread¶
Set download mode, you can set to
default
orunread
. If you set tounread
, the app will download unread chapters only (require authentication). If you set todefault
the app will download all chapters
Path / Directory¶
- --path --folder -d DIRECTORY¶
Store manga / chapter to specified directory. This option support placeholders, read Path placeholders for more info
- --filename-single -fs FILENAME_WITH_PLACEHOLDERS¶
Set filename for single format, read Path placeholders for more info
- --filename-volume -fv FILENAME_WITH_PLACEHOLDERS¶
Set filename for volume format, read Path placeholders for more info
- --filename-chapter -fc FILENAME_WITH_PLACEHOLDERS¶
Set filename for chapter format, read Path placeholders for more info
Language¶
- --language -lang LANGUAGE¶
Download manga in given language, to see all languages, use
--list-languages
option
- --list-languages -ll¶
List all available languages
Volume manga¶
- --volume-cover-language -vcl LANGUAGE¶
Override volume cover language. If this option is not set, it will follow
--language
option
- --start-volume -sv VOLUME¶
Start download chapter from given volume number
- --end-volume -ev VOLUME¶
Stop download chapter from given volume number
Chapter manga¶
- --start-chapter -sc CHAPTER¶
Start download chapter from given chapter number
- --end-chapter -ec CHAPTER¶
Stop download chapter from given chapter number
- --no-oneshot-chapter -noc¶
If manga has oneshot chapter, it will be ignored
- --no-group-name -ngn¶
Do not use scanlation group name for each chapter
- --use-chapter-title -uct¶
Use chapter title for each chapters.
Note
This option is useless if used with any single and volume format
- --range -rg¶
A range pattern to download specific chapters
- --sort-by chapter|volume¶
Download sorting method, by default it’s selected to
volume
- --use-chapter-cover -ucc¶
Enable creation of chapter info (cover) for any single or volume formats. See Chapter info (cover) for more info.
Note
Chapter info creation are not enabled if you are using any chapter format (cbz, pdf, raw, etc)
- --use-volume-cover -uvc¶
Enable creation of volume cover for any volume formats. Volume cover will be placed in first page in each volume files.
Note
Volume cover will be not created in chapter (cbz, pdf, raw, etc) and single formats
- --ignore-missing-chapters -imc¶
Ignore missing downloaded chapters. This will prevent the application to re-download the missing chapters.
- --create-no-volume -cnv¶
Merge all chapters that has no volume into 1 file for
volume
format
- --order newest|oldest¶
Change chapter order, by default it set to
newest
. Which mean it always try to download the newest chapter. Available options: newest, oldest
Chapter page manga¶
- --start-page -sp NUM_PAGE¶
Start download chapter page from given page number
- --end-page -ep NUM_PAGE¶
Stop download chapter page from given page number
Images¶
- --use-compressed-image -uci¶
Use low size images manga (compressed quality)
- --cover -c original|512px|256px|none¶
Choose quality cover, default is
original
Authentication¶
- --login -l¶
Login to MangaDex
- --login-method -lm legacy|oauth2¶
Set authentication method for MangaDex, by default it set to
legacy
. Which is directly input (username or email) and password to the application
- --login-username -lu USERNAME¶
Login to MangaDex with username or email (you will be prompted to input password if –login-password are not present)
Note
You must provide
--login
or-l
option to login. If you don’t, you will not logged in to MangaDex
- --login-password -lp PASSWORD¶
Login to MangaDex with password (you will be prompted to input username if –login-username are not present)
Note
You must provide
--login
or-l
option to login. If you don’t, you will not logged in to MangaDex
- --login-api-id -lai API_CLIENT_ID¶
Login to MangaDex with API Client. This option is working if you use
oauth2
login method (–login-method oauth2). Also you will be prompted to input API client secret if –login-api-secret are not present
- --login-api-secret -las API_CLIENT_SECRET¶
Login to MangaDex with API Client. This option is working if you use
oauth2
login method (–login-method oauth2). Also you will be prompted to input API client id if –login-api-id are not present
- --login-cache -lc¶
Cache authentication token. You don’t have to re-login with this option. You must set
MANGADEXDL_CONFIG_ENABLED=1
in your environment variables before doing this, otherwise the app will throwing error.Warning
Using this option can cause an attacker in your computer may grab your authentication cache and using it for malicious actions. USE IT WITH CAUTION !!!
Format (Save as)¶
- --save-as -f raw|raw-volume|raw-single|tachiyomi|tachiyomi-zip|pdf|pdf-volume|pdf-single|cbz|cbz-volume|cbz-single|cb7|cb7-volume|cb7-single¶
Choose save as format, default to
raw
. For more information about formats, see Supported formats
Network¶
- --proxy -p SOCKS / HTTP Proxy¶
Set http/socks proxy
- --proxy-env -pe¶
Use http/socks proxy from environments
- --force-https -fh¶
Force download images in standard HTTPS port 443
- --delay-requests -dr TIME_IN_SECONDS¶
Set delay for each requests send to MangaDex server
- --dns-over-https -doh PROVIDER¶
Enable DNS-over-HTTPS (DoH), must be one of
cloudflare
orgoogle
- --timeout TIME_IN_SECONDS¶
Set timeout for each HTTPS(s) requests
- --http-retries NUMBERS_OR_UNLIMITED¶
Set HTTP retries, use this if you want to set how much to retries if the app failed to send HTTP requests to MangaDex API. Value must be numbers or “unlimited”, by default it set to 5
Miscellaneous¶
- --input-pos¶
Automatically select choices in selectable prompt (list, library, followed-list command). You also can put asterisk (*) in this option to select all choices
Note
This option does not apply to
--use-alt-details
- -pipe¶
If set, the app will accept pipe input
- -v --version¶
Print mangadex-downloader version
- --no-track¶
Disable download tracking
Note
If you enable this, the application will not verify images and chapters. Also file
download.db
will not created.
- --no-metadata¶
Disable metadata creation (ComicInfo.xml) in any cbz format (cbz, cbz-volume, cbz-single)
- --page-size NUMBERS¶
Set maximum items displayed in page for commands and search mode. For example:
mangadex-dl library --login --page-size 50
, this example command will display 50 items per page. If you set to 0, the application will follow default limit size depends on what type of command
Console output¶
- --log-level LEVEL¶
Set logger level, available options: CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET. Default level is INFO
- --progress-bar-layout -pbl LAYOUT¶
Set progress bar layout, available options: default, stacked, none. Default layout is
default
. Set layoutnone
to disable progress bar.
- --stacked-progress-bar-order -spb-order ORDER¶
Set stacked progress bar order, available options: volumes, chapters, pages, file sizes, convert. Multiple values is supported, separated by comma. Default order is
volumes, chapters, pages, file sizes, convert
Update application¶
- --run-forever¶
Allow the application to run indefinitely with 5 seconds delay for repeating the same job
- --update¶
Update mangadex-downloader to latest version