mdx

README

mdx 📚

mdx is a simple CLI application for downloading manga from the MangaDex website. The program uses MangaDex API to fetch manga content.

Features 💫

• Works on Windows, MacOS, Linux.
• Downloads multiple chapters.
• Saving manga in CBZ and PDF formats.
• Saving multiple chapters in one file.
• Automatically generates metadata for downloaded files, adapted for e-readers.
• Searches manga.
• Displays information about manga.

Installation ⚙️

1. Download .tar.gz archive from releases page.
2. Unarchive the .tar.gz file you downloaded.

Open unarhived folder and execute mdx file for use application.

Also, you can install the application with go:

go install github.com/arimatakao/mdx@latest

Usage examples️ 🖥️

Download manga:

# get help
mdx download --help

# by default 1 chapter is downloading
mdx download -u https://mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk
# or
mdx dl -u https://mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk
# or
mdx dl https://mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84
# or
mdx dl mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84

# download pdf format instead cbz
mdx dl -e pdf mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84

# download specific chapter
mdx dl -c 123 mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk

# download range chapters
mdx dl -c 12-34 mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84

# download range chapters and merge in one file
mdx dl -m -c 12-34 mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84

# specify language, by default is english (for get available languages execute info subcommand)
mdx dl -l it mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk

# specify output directory
mdx dl -o your/dir mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk

# specify translation
mdx dl -t "Some Group" mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk

# download compressed version (lower image quality and file size)
mdx dl -j mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk

Get help about subcommands and flags:

mdx
mdx -h
# ping subcommand is example
mdx ping
mdx ping -h

Search manga:

mdx find -t "Manga Title"
mdx search -t "Manga Title"
mdx f -t "Manga Title"

Get detail information about manga:

mdx info -u https://mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk
# or
mdx info mangadex.org/title/319df2e2-e6a6-4e3a-a31c-68539c140a84/slam-dunk

Check connection to MangaDex API:

mdx ping

TODO 📌

Functionality

• Remove Doujinshi from list in find subcommand and add doujinshi flag for show Doujinshi in list.
• Add metadata for cbz downloaded archive.
• Add search filter for find subcommand.
• Add flag random in info subcommand for get information about random manga.
• Add flag to download:
  • last - download latest chapter.
  • this - download specific chapter using link from user. Make download chapter get chapter link instead manga link.
  • volume - download all chapter of specified volume.
  • volume-range - download all chapter of specified volume range.
  • oneshot - download all oneshots of manga (if available).
  • all - download all chapters.
  • merge - download chapter in one file.
  • volume-bundle - download all chapters of volume into one file.
  • extension (or format) - sets the extension of the outpud file. Add file support formats:
    • pdf (include metadata).
    • epub (include metadata).
• Add interactive mode for find subcommand.
• Add interactive mode for download subcommand.

Code

• Add tests for mangadexapi package.
• Refactor mangadexapi package.
• Refactor cmd package.
• Refactor filekit package.

License 📜

This project is licensed under the MIT - see the LICENSE file for details.

Third-party Libraries

This project uses the following third-party libraries:

• Cobra (https://github.com/spf13/cobra) - Licensed under the Apache License 2.0
• Resty (https://github.com/go-resty/resty) - Licensed under the MIT
• PTerm (https://github.com/pterm/pterm) - Licensed under the MIT
• gopdf (https://github.com/signintech/gopdf) - Licensed under the MIT