comigo

中文文档 |日本語 | English

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 (Recommended)

# Using curl:
bash <(curl -s https://raw.githubusercontent.com/yumenaka/comigo/master/get_comigo.sh)

# Using wget:
bash <(wget -qO- https://raw.githubusercontent.com/yumenaka/comigo/master/get_comigo.sh)

# 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 and add the executable to your system's PATH environment variable.

Version Selection Guide

Usage

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
• Contact me via Twitter
• Join the discussion on Discord

Special Thanks

Thanks to the following open-source projects and their contributors:

• mholt
• spf13
• disintegration
• Baozisoftware
• And many more contributors

Project Statistics

License

This software is released under the MIT license.