https://github.com/yumenaka/comigo
Comic & Manga Reader in Linux，Windows，MacOS。简单跨平台的漫画阅读器。わかりやすい漫画リーダー。
https://github.com/yumenaka/comigo
cbr cbz cli cmd comic comicreader comics-reader comigo epub golang linux macos manga nas rar raspberrypi tar windows zip
Last synced: 19 days ago
JSON representation
Comic & Manga Reader in Linux，Windows，MacOS。简单跨平台的漫画阅读器。わかりやすい漫画リーダー。
- Host: GitHub
- URL: https://github.com/yumenaka/comigo
- Owner: yumenaka
- License: mit
- Created: 2020-03-15T15:02:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-12T04:38:09.000Z (10 months ago)
- Last Synced: 2025-04-12T05:29:09.664Z (10 months ago)
- Topics: cbr, cbz, cli, cmd, comic, comicreader, comics-reader, comigo, epub, golang, linux, macos, manga, nas, rar, raspberrypi, tar, windows, zip
- Language: Go
- Homepage: https://comigo.xyz
- Size: 32.7 MB
- Stars: 259
- Watchers: 6
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ComiGo: Simple and Efficient Comic Reader
[](https://goreportcard.com/report/github.com/yumenaka/comi)
[](https://github.com/yumenaka/comigo/blob/main/LICENSE)
[中文文档](https://github.com/yumenaka/comigo/blob/master/README_CN.md) |[日本語](https://github.com/yumenaka/comigo/blob/master/README_JP.md) | [English](https://github.com/yumenaka/comigo/blob/master/README.md)
## Features
- 📚 **Multiple Format Support**: Supports image folders and compressed files like `.rar`, `.zip`, `.tar`, `.cbz`, `.cbr`, `.epub`
- 📱 **Easy Access**: QR code scanning for mobile/tablet devices, drag-and-drop support for Windows
- 🐧 **Cross-Platform**: Compatibility with Windows, Linux, and macOS
- 📖 **Diverse Reading Modes**: Offers scroll, and page-turning modes
- ⚙️ **Flexible Configuration**: Command-line operation with `config.toml` library settings
- 🖼️ **Modern Image Formats**: In addition to `jpg` and `png`, it also supports next-gen formats like `heic` and `avif`
- ✂️ **Smart Optimization**: Automatic image cropping and compression for bandwidth saving
- 🔄 **Sync Reading**: Synchronized page-turning across different devices
## Installation Guide
### Installation Script
```bash
# Recommended:
bash <(curl -s https://raw.githubusercontent.com/yumenaka/comigo/master/get.sh)
# For users in Mainland China:
bash <(curl -s https://comigo.xyz/get.sh) --cn
# If you have Golang (go 1.23 or higher):
go install github.com/yumenaka/comigo/cmd/comi@latest
```
### Manual Installation
Download the latest version from the [Releases page](https://github.com/yumenaka/comigo/releases) and add the executable to your system's `PATH` environment variable.
### Version Selection Guide
| System | Download |
|---------------------|---------------------|
| Windows 64-bit | Windows_x86_64.zip |
| Windows ARM | Windows_arm64.zip |
| MacOS Apple Silicon | MacOS_arm64.tar.gz |
| MacOS Intel | MacOS_x86_64.tar.gz |
| Linux 64-bit | Linux_x86_64.tar.gz |
| Linux ARM 32-bit | Linux_arm.tar.gz |
| Linux ARM 64-bit | Linux_arm64.tar.gz |
## Usage
```bash
comi [flags] file_or_dir
```
## Configuration File
Comigo supports configuration file locations:
1. **User Home Directory**
- Windows: `C:\Users\username\.config\comigo.toml`
- Linux/MacOS: `/home/username/.config/comigo.toml`
- Default location read at startup
2. **Program Directory**
- Place `comigo.toml` in the same directory as the executable
- Suitable for portable usage
3. **Current Working Directory**
- Searches for configuration file in the current directory when running commands
4. **Custom Location**
- Specify configuration file path using the `--config` parameter
## Feedback and Support
If you have any suggestions or encounter issues, feel free to:
- Submit an [Issue](https://github.com/yumenaka/comigo/issues)
- Contact me via [Twitter](https://x.com/yumenaka7)
- Join the discussion on [Discord](https://discord.gg/c5q6d3dM8r)
## Special Thanks
Thanks to the following open-source projects and their contributors:
- [mholt](https://github.com/mholt)
- [spf13](https://github.com/spf13)
- [disintegration](https://github.com/disintegration)
- [Baozisoftware](https://github.com/Baozisoftware)
- And many more contributors
## Project Statistics
[](https://starchart.cc/yumenaka/comigo)
## License
This software is released under the MIT license.