Skip to content

README.md

Latest commit

 

History

History
107 lines (72 loc) · 3.17 KB

README.md

File metadata and controls

107 lines (72 loc) · 3.17 KB

Mangarr

Mangarr downloads manga chapters from supported sources and saves them as .cbz archives. Use it for quick one-off downloads or let it run in monitor mode and fetch new chapters for you.

Release License

Why Use It

  • Download the latest, first, specific, or all available chapters.
  • Monitor series and auto-download new releases.
  • Save chapters as .cbz files that work with comic and manga readers.
  • Run as a native binary or with Docker.

Install

Binary

Download the latest release for your platform from the releases page.

Available for:

  • Linux (amd64, arm, arm64)
  • Windows (amd64)
  • macOS (amd64, arm64)
  • FreeBSD (amd64)

Docker

docker pull ghcr.io/nuxencs/mangarr:latest

Check the installed version:

mangarr version

Quick Start

Download the latest chapter from a source:

mangarr download --help
mangarr download -d ./downloads -s tcbscans -m "One Piece"

If you want a different source, the value you pass to -m changes by provider. Use the table below.

Monitor Mode

Create a config.yaml:

downloadLocation: "/path/to/downloads"
checkInterval: 15

monitoredManga:
  One Piece:
    source: "tcbscans"
    manga: "One Piece"

Run the monitor:

mangarr monitor -c ~/.config/mangarr

-c should point to the directory that contains config.yaml. If you omit it, mangarr also checks common default locations. Full config and override details live in docs/USAGE.md.

Supported Sources

Source -s value Pass to -m Extra input
TCB Scans tcbscans exact manga title none
MangaDex mangadex manga UUID optional -g group UUID, optional -l language
MANGA Plus mangaplus numeric title ID none
Flame Comics flamecomics full series URL none
Asura Scans asurascans full https://asurascans.com/comics/... URL locked early-access chapters are skipped until public
Cubari cubari gist URL required -g group
Weeb Central weebcentral full https://weebcentral.com/... URL none
Comix comix full https://comix.to/title/... URL optional -g group

More Docs

User docs:

Maintainer docs:

License

This project is licensed under the MIT License. See LICENSE.

Disclaimer

Personal use only. Respect the rights of creators and publishers, and support official releases when possible.