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.
• Saves manga in CBZ, PDF, EPUB formats.
• Saves 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.

Open the unarchived folder and execute the mdx file to use the application.

You can also 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 being downloaded
mdx download -u https://mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370/this-gorilla-will-die-in-1-day
# or
mdx dl -u https://mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370/this-gorilla-will-die-in-1-day
# or
mdx dl https://mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370
# or
mdx dl mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# download pdf format instead of cbz
mdx dl -e pdf mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# download a specific chapter
mdx dl -c 123 mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370
# or set direct link to the chapter
mdx dl --this mangadex.org/chapter/7c5d2aea-ea55-47d9-8c65-a33c9e92df70
# or
mdx dl https://mangadex.org/chapter/7c5d2aea-ea55-47d9-8c65-a33c9e92df70

# download a range of chapters
mdx dl -c 12-34 mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# download a range of chapters and merge them in one file
mdx dl -m -c 12-34 mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# download last chapter
mdx dl --last mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# specify language, default is english (to get the available languages, execute the info subcommand)
mdx dl -l it mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# specify the output directory
mdx dl -o your/dir mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# specify translation
mdx dl -t "Some Group" mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

# download compressed version (lower image quality and file size)
mdx dl -j mangadex.org/title/a3f91d0b-02f5-4a3d-a2d0-f0bde7152370

Check available updates:

mdx update

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 detailed information about the 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 check update subcommand.
• Add self update mechanism.
• Add search filter for find subcommand.
• Add flag random in info subcommand to get information about random manga.
• Add flag to download:
  • last - download latest chapter.
  • this - download a specific chapter using a link provided by the user.
  • volume - download all chapters of specified volume.
  • volume-range - download all chapters 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 - sets the extension of the output file. Add file support formats:
    • pdf (include metadata).
    • epub (include metadata).
• Add interactive mode for find subcommand.
• Add interactive mode for download subcommand.

Code

• Use pterm output instead fmt.
• Create a Github action to automate the creation of .deb .rpm .pkg.tar.zst packages when a new release is created.
• 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
• go-epub (https://github.com/go-shiori/go-epub) - Licensed under the MIT

Contributors

• arimatakao
• wolandark