comigo

Try it Online

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
• 📴 Offline Mode / PWA App: Read ZIP/CBZ/RAR/CBR directly in your browser without uploading files
• 🐧 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 Use: Supports remote Comigo libraries, batch image-folder downloads, and EPUB conversion
• 📜 Reading History: Automatic reading history tracking for easy continuation

PC/Mobile Sync:

Omarchy status bar integration

Comigo supports Omarchy through the comigo-omarchy plugin, which controls local or remote services from the status bar.

omarchy plugin add https://github.com/yumenaka/comigo-omarchy --enable

Installation Guide

GUI Version (Recommended for Beginners)

💡 Which GUI package should I choose? Choose Tray if you want ComiGo to keep running in the background and manage it from the system tray. The Tray version starts the local Web service and opens the reader in your browser; the tray menu can open the browser, copy the reading URL, open config/library folders, switch languages, check for updates, and toggle Tailscale remote access. On Windows, it can also register folder context menus, file associations, and desktop shortcuts.

Choose Desktop if you prefer a regular app window. It wraps the same ComiGo reader in a Wails desktop shell and adds desktop-only actions such as selecting folders with the system picker and moving local source files to the system trash after confirmation. The current Desktop build does not include the tray menu or built-in Tailscale remote access.

macOS tip: If macOS says the app is damaged and should be moved to Trash, the downloaded file is usually not actually broken. Run this after moving the app to Applications:

xattr -dr com.apple.quarantine /Applications/comigo-desktop.app

Quick Install for CLI

# Recommended:
installer=$(curl -fsSL https://raw.githubusercontent.com/yumenaka/comigo/master/get.sh) && bash -c "$installer" --

# For users in Mainland China:
installer=$(curl -fsSL https://comigo.xyz/get.sh) && bash -c "$installer" -- --cn

# If you have Golang (go 1.23 or higher):
go install github.com/yumenaka/comigo/cmd/comi@latest

The installer defaults to $HOME/.local/bin and does not edit shell configuration. It checks both the available comi command and the destination file. If the requested version is already installed, a terminal prompt offers skip (default) or overwrite at the displayed destination; without a terminal it skips. Use --force to overwrite the same version non-interactively.

For the examples below, first download the script with curl -fSL -o get.sh https://raw.githubusercontent.com/yumenaka/comigo/master/get.sh.

bash get.sh --help
bash get.sh --version v1.2.22
bash get.sh --system                 # /usr/local/bin; root-owned, sudo when needed
bash get.sh --install-dir "$HOME/bin" # overrides COMIGO_INSTALL_DIR
bash get.sh --force                  # overwrite the same version

The destination remains explicit: an existing command elsewhere is not automatically replaced. Use --system or --install-dir to select its directory. The installer reports if PATH selects another copy and prints shell-specific PATH instructions. Explicit directories never silently fall back; symlink targets are rejected. To uninstall, remove only comi from the chosen directory (use the package manager if it manages that copy).

Downloads require the release asset checksums.txt; for older releases without it, explicitly add --skip-checksum to disable verification. make all generates the SHA-256 manifest after building all packages; publish it alongside the release assets. To regenerate it separately, run make checksums VERSION=vX.Y.Z.

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

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

Development with mise

The committed mise.toml pins Go, Bun, GNU Make, templ, Wails v2, Air, sqlc, Ent, and goversioninfo. It uses mise's documented core, go:, and conda: backends; GNU Make is provided by conda:make, whose mise backend supports macOS, Linux, and Windows x64 without a separate Conda installation.

The initialization and task flow below was verified on macOS ARM64 with mise 2026.8.14. The Linux and Windows commands and platform limits come from the linked official mise and Wails documentation.

Install and activate mise

Follow the official mise Getting Started and installation documentation.

macOS and Linux:

curl https://mise.run | sh

# Bash
echo 'eval "$(~/.local/bin/mise activate bash)"' >> ~/.bashrc

# Zsh (use this instead on the default macOS shell)
echo 'eval "$(~/.local/bin/mise activate zsh)"' >> ~/.zshrc

Restart the shell after adding one activation line. Homebrew is also supported with brew install mise, though the official installer is mise's recommended method.

Windows PowerShell:

# Recommended; Scoop also adds mise shims to PATH.
scoop install mise

# Alternative
winget install jdx.mise

PowerShell activation is optional when the Scoop shims are available. To enable automatic environment switching, add the official activation command to your actual PowerShell profile:

New-Item -ItemType Directory -Force (Split-Path $PROFILE)
Add-Content $PROFILE '(&mise activate pwsh) | Out-String | Invoke-Expression'

Initialize the repository

The commands are the same in Bash, Zsh, and PowerShell:

git clone https://github.com/yumenaka/comigo.git
cd comigo
mise trust
mise install
mise run setup
mise doctor

mise install installs the pinned tools. mise run setup downloads Go modules and runs bun install; mise tasks also install any missing configured tools automatically. Run wails doctor once before desktop development. Wails still needs native platform components that mise cannot supply: Xcode Command Line Tools on macOS, WebView2 on Windows, or GCC, GTK3, and WebKitGTK development packages on Linux. See the official Wails v2 installation guide.

On Windows x64, normal mise tasks work from PowerShell. The release-oriented Make targets additionally use POSIX utilities such as sh, cp, rm, zip, and find, so run those targets in MSYS2 with its toolchain on PATH. The mise Conda backend does not currently list Windows ARM64; on that host, install Make through MSYS2 and run the release targets there. Docker, platform SDKs, dpkg, UPX, and similar release dependencies remain system-managed.

Common tasks and aliases

Run mise tasks to see the full list. Task aliases use the documented mise run <alias> form.

Direct Make targets remain available inside the pinned environment, for example mise exec -- make wails-prepare or mise exec -- make docker-help.

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

Star History

License

This software is released under the MIT license.