Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darylhjd/mangadesk
Terminal client for MangaDex 📖
https://github.com/darylhjd/mangadesk
cli downloader go golang manga manga-downloader mangadex mangadownloader terminal terminal-app terminal-based tui tview
Last synced: 3 months ago
JSON representation
Terminal client for MangaDex 📖
- Host: GitHub
- URL: https://github.com/darylhjd/mangadesk
- Owner: darylhjd
- License: mit
- Created: 2021-05-09T15:38:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-24T07:40:42.000Z (6 months ago)
- Last Synced: 2024-06-20T06:27:01.634Z (5 months ago)
- Topics: cli, downloader, go, golang, manga, manga-downloader, mangadex, mangadownloader, terminal, terminal-app, terminal-based, tui, tview
- Language: Go
- Homepage:
- Size: 12.5 MB
- Stars: 740
- Watchers: 5
- Forks: 29
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mangadesk 📖
[](https://github.com/darylhjd/mangadesk/search?l=go)
[](https://github.com/darylhjd/mangadesk/blob/main/LICENSE)
[](https://goreportcard.com/report/github.com/darylhjd/mangadesk)
[](https://github.com/darylhjd/mangadesk/releases)
**Note: Maintenance mode. Only severe bugs _may_ be fixed.**
The ultimate MangaDex terminal client!
## Features ✨
- Download chapters straight to your computer.
- Login to keep track of your followed manga.
- Download multiple chapters together.
- Searching!
- (Yes, you can use this to scrape manga).
- Written in Golang :)
Works for Windows/Linux/macOS.
## Installation 🔧
This application runs as a standalone executable, and does not need to be installed.
Check out the [Releases Page](https://github.com/darylhjd/mangadesk/releases) for new releases. To update, just
download the latest release.
For bleeding edge 🗡 updates, you may also compile from source:
```cmd
$ git clone https://github.com/darylhjd/mangadesk.git
$ cd mangadesk
$ go get -d ./...
$ go build
```
### Arch Linux
Mangadesk is available through the [AUR](https://aur.archlinux.org/packages/mangadesk/) and may be installed as such (thanks @AmaanHUB!).
It may be installed manually or with your preferred AUR helper:
```cmd
$ paru -S mangadesk
```
### Ubuntu
Mangadesk is available through the [MPR](https://mpr.makedeb.org/packages/mangadesk) and can be installed manually or with your preferred MPR helper:
```cmd
$ una install mangadesk
```
### Void Linux
Mangadesk is available through the official Void repositories and can be installed via XBPS:
```cmd
$ xbps-install -S mangadesk
```
## Uninstall ❌
To uninstall, simply delete the executable and its related folders and files.
Your downloads will not be removed by deleting the executable.
### Arch Linux
Uninstall with an AUR helper or with pacman:
```cmd
$ pacman -R mangadesk
```
### Ubuntu
Uninstall with a MPR helper or with APT:
```cmd
$ una remove mangadesk
```
### Void Linux
Uninstall with XBPS:
```cmd
$ xbps-remove -R mangadesk
```
## Usage ✍
To run the application, navigate to the directory where you stored the executable, and run the following command:
```cmd
$ ./mangadesk
```
Steps may differ for different OSes. For example, in Windows, use a backslash `\` instead.
### Keybindings ⌨
| Operation | Binding |
|-------------------------------------------------------------------------------------------|----------------------------------|
| Login/Logout | Ctrl + L |
| Keybindings/Help | Ctrl + K |
| Search | Ctrl + S |
| Next/Prev Page | Ctrl + F/B |
| Escape | Esc |
| Select a chapter | Ctrl + E |
| Toggle select all chapters | Ctrl + A |
| Toggle chapter(s) read status
*Note: You can select multiple chapters to toggle! | Ctrl + R |
| Toggle manga following | Ctrl + Q |
## Settings ⚙
Refer to [this document](app/core/CONFIG.md) for configurable settings.
## Issues ☠
Check out the Issues page for current issues/feature requests.
## Contributing 🤝
Always welcome and appreciated :)
Please take some time to familiarise yourself with the [contributing guidelines](.github/CONTRIBUTING.md).
## Learning Points 🧠
- Creating TUIs with tview/tcell.
- Working with the filesystem in Golang.
- Goroutines & Context.
- Go project structure.