{"id":14015642,"url":"https://github.com/josueBarretogit/manga-tui","last_synced_at":"2025-07-25T10:31:49.056Z","repository":{"id":251639068,"uuid":"813347624","full_name":"josueBarretogit/manga-tui","owner":"josueBarretogit","description":"Terminal-based manga reader and downloader with image rendering support ","archived":false,"fork":false,"pushed_at":"2025-07-19T22:06:16.000Z","size":5662,"stargazers_count":672,"open_issues_count":20,"forks_count":18,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-07-20T00:52:03.091Z","etag":null,"topics":["anilist","anime","cbz","comic-downloader","comic-reader","linux","macos","manga","manga-downloader","manga-reader","manga-scraper","mangadex","ratatui","rust","terminal","terminal-app","terminal-based","tui","tui-app","windows"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/manga-tui","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/josueBarretogit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-10T23:02:19.000Z","updated_at":"2025-07-19T22:03:36.000Z","dependencies_parsed_at":"2024-08-11T03:02:24.354Z","dependency_job_id":null,"html_url":"https://github.com/josueBarretogit/manga-tui","commit_stats":null,"previous_names":["josuebarretogit/manga-tui"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/josueBarretogit/manga-tui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josueBarretogit%2Fmanga-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josueBarretogit%2Fmanga-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josueBarretogit%2Fmanga-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josueBarretogit%2Fmanga-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/josueBarretogit","download_url":"https://codeload.github.com/josueBarretogit/manga-tui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josueBarretogit%2Fmanga-tui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266990934,"owners_count":24017732,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["anilist","anime","cbz","comic-downloader","comic-reader","linux","macos","manga","manga-downloader","manga-reader","manga-scraper","mangadex","ratatui","rust","terminal","terminal-app","terminal-based","tui","tui-app","windows"],"created_at":"2024-08-11T03:01:06.285Z","updated_at":"2025-07-25T10:31:47.504Z","avatar_url":"https://github.com/josueBarretogit.png","language":"Rust","funding_links":[],"categories":["Rust","💻 Apps","Table of Contents"],"sub_categories":["🎼 Music and Media"],"readme":"\u003ch1 align=\"center\"\u003e\n\u003cstrong\u003e 📖 Manga-tui 🖥️ \u003c/strong\u003e\n\u003c/h1\u003e\n\n\u003ch3 align=\"center\"\u003e\n    Terminal-based manga reader and downloader written in rust 🦀\n\u003c/h3\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/josueBarretogit/manga-tui/actions/workflows/test.yml\"\u003e\n        \u003cimg alt=\"test passing\" src=\"https://img.shields.io/github/actions/workflow/status/josueBarretogit/manga-tui/test.yml?label=tests\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://crates.io/crates/manga-tui\"\u003e\n        \u003cimg alt=\"crates io downloads\" src=\"https://img.shields.io/crates/d/manga-tui?logo=rust\u0026label=crates.io downloads\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/josueBarretogit/manga-tui/releases/latest\"\u003e\n        \u003cimg alt=\"downloads\" src=\"https://img.shields.io/github/downloads/josuebarretogit/manga-tui/total\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/josueBarretogit/manga-tui/blob/main/LICENSE\"\u003e\n        \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/josueBarretogit/Manga-tui?style=flat-square\u0026color=blue\"\u003e\n    \u003c/a\u003e\n\u003c/div \u003e\n\n\u003cp align=\"center\"\u003e\n\n\u003chttps://github.com/user-attachments/assets/2b693bd3-ec30-4d6e-bcc4-6cf457a860b1\u003e\n\n\u003c/p\u003e\n\n## Table of contents\n\n- [Features](#features)\n- [Dependencies](#dependencies)\n- [Installation](#installation)\n- [Image rendering](#image-rendering)\n- [Usage](#usage)\n- [Manga providers](#manga-providers)\n- [Configuration](#configuration)\n- [Motivation](#motivation)\n- [Credits](#credits)\n\n## Features\n\n- [Mangadex](https://mangadex.org/) and [Weebcentral](https://weebcentral.com/) are available as manga providers\n\n- Track your reading history with [anilist integration](./docs/anilist.md)\n\n- Advanced search (with filters)\n\n\u003chttps://github.com/user-attachments/assets/c1e21aa1-8a51-4c47-baea-9f56dcd0d6a4\u003e\n\n- Read manga in your terminal with terminals such as: Wezterm, iTerm2, Kitty, Ghostty\n  \n\u003chttps://github.com/user-attachments/assets/70f321ff-13d1-4c4b-9c37-604271456ab2\u003e\n\n- Reading history is stored locally (with no login required)\n\n \u003chttps://github.com/user-attachments/assets/47e88e89-f73c-4575-9645-2abb80ca7d63\u003e\n\n- Download manga (available formats: cbz, epub, pdf and raw images)\n\n\u003chttps://github.com/user-attachments/assets/ba785668-7cf1-4367-93f9-6e6e1f72c12c\u003e\n\n- Download all chapters of a manga (available formats: cbz, epub, pdf and raw images)\n\n\u003chttps://github.com/user-attachments/assets/26ad493f-633c-41fc-9d09-49b316118923\u003e\n\n### Join the [discord](https://discord.gg/jNzuDCH3) server for further help, feature requests or to chat with contributors\n\n## Dependencies\n\nOn linux you may need to install the D-bus secret service library\n\n### Debian\n\n```shell\nsudo apt install libdbus-1-dev pkg-config\n```\n\n### Fedora\n\n```shell\nsudo dnf install dbus-devel pkgconf-pkg-config\n```\n\n### Arch\n\n```shell\nsudo pacman -S dbus pkgconf\n```\n\n## Installation\n\n### Using cargo\n\n```shell\ncargo install manga-tui --locked\n```\n\n### AUR\n\nYou can install `manga-tui` from the [AUR](https://aur.archlinux.org/packages/manga-tui) with using an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers).\n\n```shell\nparu -S manga-tui\n```\n\n### Nix\n\nIf you have the [Nix package manager](https://nixos.org/), this repo provides a flake that builds the latest git version from source.\n\nSimply run the following:\n\n```sh\nnix run 'github:josueBarretogit/manga-tui'\n```\n\nOr, to install persistently:\n\n```sh\nnix profile install 'github:josueBarretogit/manga-tui'\n```\n\n## Binary release\n\nDownload a binary from the [releases page](https://github.com/josueBarretogit/manga-tui/releases/latest)\n\n## Image rendering\n\nUse a terminal that can render images such as [Wezterm](https://wezfurlong.org/wezterm/index.html) (Personally I recommend using this one It's the one used in the videos), [iTerm2](https://iterm2.com/), [Kitty](https://sw.kovidgoyal.net/kitty/) and [Ghostty](https://ghostty.org/download)  \u003cbr /\u003e\nFor more information see: [image-support](https://github.com/benjajaja/ratatui-image?tab=readme-ov-file#compatibility-matrix)\n\n\u003e [!WARNING]\n\u003e On windows image display is very buggy, see [this issue](https://github.com/josueBarretogit/manga-tui/issues/26) for more information\n\nNo images will be displayed if the terminal does not have image support  (but `manga-tui` will still work as a manga downloader)\n\n## Usage\n\nAfter installation just run the binary\n\n```shell\nmanga-tui\n```\n\n## Manga providers\n\n\u003e [!WARNING]\n\u003e Expect any manga provider to fail at some point, either due to them closing operations due to a [lawsuit](https://www.japantimes.co.jp/news/2024/04/18/japan/crime-legal/manga-mura-copyright-ruling/) or the provider itself having issues on their end like [manganato](https://github.com/josueBarretogit/manga-tui/issues/132)\n\nBy default when you run `manga-tui` Mangadex will be used\n\n```shell\nmanga-tui\n```\n\nIf you want to use Weebcentral or any other provider available then run:\n\n```shell\nmanga-tui -p weebcentral\n```\n\n## Configuration\n\nThe config file is located at `XDG_CONFIG_HOME/manga-tui/config.toml`, to know where it is you can run:\n\n```shell\nmanga-tui --config-dir \n\n# or\n\nmanga-tui -c\n```\n\nWhich provides the following configuration:\n\n```toml\n# The format of the manga downloaded\n# values: cbz, raw, epub, pdf\n# default: \"cbz\"\ndownload_type = \"cbz\"\n\n# Download image quality, low quality means images are compressed and is recommended for slow internet connections\n# values: low, high \n# default: \"low\"\nimage_quality = \"low\"\n\n# Pages around the currently selected page to try to prefetch\n# values: 0-255\n# default: 5\namount_pages = 5\n\n# Whether or not bookmarking is done automatically, if false you decide which chapter to bookmark\n# values: true, false\n# default: true\nauto_bookmark = true\n\n# Whether or not downloading a manga counts as reading it on services like anilist\n# values: true, false\n# default: false\ntrack_reading_when_download = false\n\n# Enable / disable checking for new updates\n# values: true, false\n# default: true\ncheck_new_updates = true\n\n# Sets which manga provider will be used when running manga-tui, \n# you can override it by running manga-tui with the -p flag like this: manga-tui -p weebcentral\n# values: mangadex, weebcentral\n# default: \"mangadex\"\ndefault_manga_provider = \"mangadex\"\n\n# Enable / disable tracking reading history with services like `anilist`\n# values: true, false\n# default: true\ntrack_reading_history = true\n\n# Anilist-related config, if you want `manga-tui` to read your anilist credentials from this file then place them here\n[anilist]\n# Your client id from your anilist account\n# leave it as an empty string \"\" if you don't want to use the config file to read your anilist credentials\n# values: string\n# default: \"\"\nclient_id = \"\"\n\n# Your acces token from your anilist account\n# leave it as an empty string \"\" if you don't want to use the config file to read your anilist credentials\n# values: string\n# default: \"\"\naccess_token = \"\"\n```\n\nManga downloads and reading history is stored in the `manga-tui` directory, to know where it is run:\n\n```shell\nmanga-tui --data-dir \n\n# or\n\nmanga-tui -d\n```\n\nOn linux it will output something like: `~/.local/share/manga-tui` \u003cbr /\u003e\n\nOn the `manga-tui` directory there will be 3 directories\n\n- `history`, which contains a sqlite database to store reading history\n- `mangaDownloads`, where manga will be downloaded\n- `errorLogs`, for storing posible errors / bugs\n\nIf you want to change the location of this directory you can set the environment variable `MANGA_TUI_DATA_DIR` to some path pointing to a directory, like: \u003cbr /\u003e\n\n```shell\nexport MANGA_TUI_DATA_DIR=\"/home/user/Desktop/mangas\"\n```\n\n\u003e [!NOTE]\n\u003e Mangadex-only feature\nBy default `manga-tui` will search mangas in english, you can change the language by running:\n\n```shell\n# `es` corresponds to the Iso code for spanish\nmanga-tui lang --set 'es'\n```\n\n\u003e [!NOTE]\n\u003e Mangadex-only feature\nCheck the available languages and their Iso codes by running:\n\n```shell\nmanga-tui lang --print\n```\n\n## Motivation\n\nI wanted to make a \"How linux user does ...\" but for manga, [here is the video](https://www.youtube.com/watch?v=K0FsGRqEc1c) also this is a great excuse to start reading manga again\n\n## Credits\n\nMany thanks to Mangadex for providing the free API please consider supporting them ❤️  \u003cbr /\u003e\nMany thanks to the [Ratatui organization](https://github.com/ratatui-org) for making such a good library for making TUI's in rust 🐭 \u003cbr /\u003e\nMany thanks to the developer of the [Ratatui-image crate](https://crates.io/crates/ratatui-image) for providing a widget that renders images in the terminal 🖼️ \u003cbr /\u003e\n\nConsider giving a star to this project ⭐\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FjosueBarretogit%2Fmanga-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FjosueBarretogit%2Fmanga-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FjosueBarretogit%2Fmanga-tui/lists"}