comigo

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
• 🔌 Plugin System: Built-in plugins like auto page-turn and clock, with custom plugin support
• 🎬 Media Playback: Built-in audio and video player
• 📥 Flexible Download: Batch download image folders, convert and download as EPUB format
• 📜 Reading History: Automatic reading history tracking for easy continuation

Installation Guide

GUI Version (Recommended for Beginners)

💡 Note: GUI version provides system tray icon, can run minimized in background. Windows: Double-click to run; macOS: Drag to Applications folder.

Quick Install for CLI

# 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

CLI Version

💡 Note: CLI version suitable for server deployment and advanced users. Manual PATH configuration required after download.

Manual Installation

Download the latest version from the Releases page and add the executable to your system's PATH environment variable.

Docker Deployment

Quick Start with Docker

# Pull and run the latest image
docker run -d \
  --name comigo \
  -p 1234:1234 \
  -v /path/to/your/books:/data \
  yumenaka/comigo:latest

Visit http://localhost:1234 to access your library.

Using Docker Compose

1. Download the docker-compose.yml file
2. Edit the configuration as needed
3. Start the service:

docker-compose up -d

Supported Platforms

• linux/amd64 - Standard x86_64 servers
• linux/arm64 - ARM64 servers (Raspberry Pi 4/5)
• linux/arm/v7 - ARMv7 devices (Raspberry Pi 2-4)

Environment Variables

For more details, see the complete Docker documentation.

Usage

comi [flags] file_or_dir

Command Line Options

Examples

# Open current directory
comi .

# Specify port and path
comi -p 8080 /path/to/manga

# Local only with login protection
comi --local --username admin --password 123456 /path/to/manga

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.