{"id":15172923,"url":"https://github.com/yumenaka/comigo","last_synced_at":"2026-05-17T15:08:16.690Z","repository":{"id":38321467,"uuid":"247489084","full_name":"yumenaka/comigo","owner":"yumenaka","description":"Comic \u0026 Manga Reader in Linux，Windows，MacOS。简单跨平台的漫画阅读器。わかりやすい漫画リーダー。","archived":false,"fork":false,"pushed_at":"2026-05-10T11:08:38.000Z","size":33847,"stargazers_count":336,"open_issues_count":6,"forks_count":14,"subscribers_count":7,"default_branch":"master","last_synced_at":"2026-05-10T12:09:11.106Z","etag":null,"topics":["cbr","cbz","cli","cmd","comic","comicreader","comics-reader","comigo","epub","golang","linux","macos","manga","nas","rar","raspberrypi","self-hosted","tar","windows","zip"],"latest_commit_sha":null,"homepage":"https://comigo.xyz","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yumenaka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2020-03-15T15:02:43.000Z","updated_at":"2026-05-10T11:08:41.000Z","dependencies_parsed_at":"2026-03-05T16:01:12.126Z","dependency_job_id":null,"html_url":"https://github.com/yumenaka/comigo","commit_stats":{"total_commits":642,"total_committers":5,"mean_commits":128.4,"dds":0.1199376947040498,"last_synced_commit":"5cc66897595b364112ef2d22a403f394248fd199"},"previous_names":["yumenaka/comigo","yumenaka/comi"],"tags_count":80,"template":false,"template_full_name":null,"purl":"pkg:github/yumenaka/comigo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yumenaka%2Fcomigo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yumenaka%2Fcomigo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yumenaka%2Fcomigo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yumenaka%2Fcomigo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yumenaka","download_url":"https://codeload.github.com/yumenaka/comigo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yumenaka%2Fcomigo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33143276,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T09:28:26.183Z","status":"ssl_error","status_checked_at":"2026-05-17T09:27:52.702Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cbr","cbz","cli","cmd","comic","comicreader","comics-reader","comigo","epub","golang","linux","macos","manga","nas","rar","raspberrypi","self-hosted","tar","windows","zip"],"created_at":"2024-09-27T10:23:52.316Z","updated_at":"2026-05-17T15:08:16.685Z","avatar_url":"https://github.com/yumenaka.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# ComiGo: Simple and Efficient Comic Reader  \n[![Go Report](https://goreportcard.com/badge/github.com/yumenaka/comi?style=flat-square)](https://goreportcard.com/report/github.com/yumenaka/comi)\n[![License](https://img.shields.io/github/license/yumenaka/comi?style=flat-square\u0026color=blue)](https://github.com/yumenaka/comigo/blob/main/LICENSE)  \n[中文文档](https://github.com/yumenaka/comigo/blob/master/README_ZH.md) | [日本語](https://github.com/yumenaka/comigo/blob/master/README_JP.md) | [English](https://github.com/yumenaka/comigo/blob/master/README.md)\n\u003c!--\n[![Downloads](https://img.shields.io/github/downloads/yumenaka/comi/total?style=flat-square\u0026color=success)](https://github.com/yumenaka/comigo/releases)\n\u003cimg src=\"https://raw.githubusercontent.com/yumenaka/comi/master/icon.ico\" alt=\"ComiGo：Simple Comig \u0026 Manga Reader\" width=\"200\"\u003e\n--\u003e\n\u003c/div\u003e\n\n![Windows Sample](https://www.yumenaka.net/wp-content/uploads/2020/08/sample.gif \"Windows Sample\")\n\n## [Try it Online](https://comigo.xyz/reader)\n\n## Features\n\n- 📚 **Multiple Format Support**: Supports image folders and compressed files like `.rar`, `.zip`, `.tar`, `.cbz`, `.cbr`, `.epub`\n- 📱 **Easy Access**: QR code scanning for mobile/tablet devices, drag-and-drop support for Windows\n- 📴 **Offline Mode / PWA App**: Read ZIP/CBZ/RAR/CBR directly in your browser without uploading files\n- 🐧 **Cross-Platform**: Compatibility with Windows, Linux, and macOS\n- 📖 **Diverse Reading Modes**: Offers scroll, and page-turning modes\n- ⚙️ **Flexible Configuration**: Command-line operation with `config.toml` library settings\n- 🖼️ **Modern Image Formats**: In addition to `jpg` and `png`, it also supports next-gen formats like `heic` and `avif`\n- ✂️ **Smart Optimization**: Automatic image cropping and compression for bandwidth saving\n- 🔄 **Sync Reading**: Synchronized page-turning across different devices\n- 🔌 **Plugin System**: Built-in plugins like auto page-turn and clock, with custom plugin support\n- 🎬 **Media Playback**: Built-in audio and video player\n- 📥 **Flexible Download**: Batch download image folders, convert and download as EPUB format\n- 📜 **Reading History**: Automatic reading history tracking for easy continuation\n\nPC/Mobile Sync:   \n![Mobile Sync Sample](https://www.yumenaka.net/wp-content/uploads/2026/04/scroll.gif \"Mobile Sync Sample\")\n\n## Installation Guide\n\n### GUI Version (Recommended for Beginners)\n\n| System | Download |\n|--------|----------|\n| Windows 64-bit | [comigo_latest_Windows_x86_64_full.zip](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comigo_latest_Windows_x86_64_full.zip) |\n| macOS (Intel/Apple Silicon) | [Comigo_latest.dmg](https://comigo.xyz/yumenaka/comigo/releases/download/latest/Comigo_latest.dmg) |\n\n\u003e 💡 **Note**: GUI version provides system tray icon, can run minimized in background. Windows: Double-click to run; macOS: Drag to Applications folder.\n\n### Quick Install for CLI\n\n```bash\n# Recommended:\nbash \u003c(curl -s https://raw.githubusercontent.com/yumenaka/comigo/master/get.sh)\n\n# For users in Mainland China:\nbash \u003c(curl -s https://comigo.xyz/get.sh) --cn\n\n# If you have Golang (go 1.23 or higher):\ngo install github.com/yumenaka/comigo/cmd/comi@latest\n```\n\n### CLI Version\n\n| System | Download |\n|--------|----------|\n| Windows 64-bit | [comi_latest_Windows_x86_64.zip](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_Windows_x86_64.zip) |\n| Windows ARM | [comi_latest_Windows_arm64.zip](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_Windows_arm64.zip) |\n| macOS Intel | [comi_latest_MacOS_x86_64.tar.gz](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_MacOS_x86_64.tar.gz) |\n| macOS Apple Silicon | [comi_latest_MacOS_arm64.tar.gz](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_MacOS_arm64.tar.gz) |\n| Linux 64-bit | [comi_latest_Linux_x86_64.tar.gz](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_Linux_x86_64.tar.gz) |\n| Linux ARM64 | [comi_latest_Linux_arm64.tar.gz](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_Linux_arm64.tar.gz) |\n| Linux ARM32 | [comi_latest_Linux_armv7.tar.gz](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_Linux_armv7.tar.gz) |\n| Debian/Ubuntu 64-bit | [comi_latest_amd64.deb](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_amd64.deb) |\n| Debian/Ubuntu ARM64 | [comi_latest_arm64.deb](https://comigo.xyz/yumenaka/comigo/releases/download/latest/comi_latest_arm64.deb) |\n\n\u003e 💡 **Note**: CLI version suitable for server deployment and advanced users. Manual PATH configuration required after download.\n\n### Manual Installation\n\nDownload the latest version from the [Releases page](https://github.com/yumenaka/comigo/releases) and add the executable to your system's `PATH` environment variable.\n\n## Docker Deployment\n\n### Quick Start with Docker\n\n```bash\n# Pull and run the latest image\ndocker run -d \\\n  --name comigo \\\n  -p 1234:1234 \\\n  -v /path/to/your/books:/data \\\n  yumenaka/comigo:latest\n```\n\nVisit `http://localhost:1234` to access your library.\n\n### Using Docker Compose\n\n1. Download the [`docker-compose.yml`](sample/docker/docker-compose.yml) file\n2. Edit the configuration as needed\n3. Start the service:\n\n```bash\ndocker-compose up -d\n```\n\n### Supported Platforms\n\n- `linux/amd64` - Standard x86_64 servers\n- `linux/arm64` - ARM64 servers (Raspberry Pi 4/5)\n- `linux/arm/v7` - ARMv7 devices (Raspberry Pi 2-4)\n\n### Environment Variables\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `COMIGO_PORT` | Service port | `1234` |\n| `COMIGO_USERNAME` | Login username (optional) | - |\n| `COMIGO_PASSWORD` | Login password (optional) | - |\n| `COMIGO_ENABLE_UPLOAD` | Enable file upload | `true` |\n\nFor more details, see the complete [Docker documentation](sample/docker/README.md).\n\n## Usage\n\n```bash\ncomi [flags] file_or_dir\n```\n\n### Command Line Options\n\n| Option | Short | Default | Description |\n|--------|-------|---------|-------------|\n| `--config` | `-c` | - | Specify config file path |\n| `--port` | `-p` | 1234 | Service port |\n| `--host` | - | - | Custom hostname/domain |\n| `--local` | - | false | Local access only |\n| `--max-depth` | `-m` | 5 | Max scan depth |\n| `--open-browser` | `-o` | false | Open browser on start |\n| `--enable-upload` | - | true | Enable file upload |\n| `--read-only` | - | false | Read-only mode |\n| `--username` | - | - | Login username |\n| `--password` | - | - | Login password |\n| `--debug` | - | false | Debug mode |\n\n### Examples\n\n```bash\n# Open current directory\ncomi .\n\n# Specify port and path\ncomi -p 8080 /path/to/manga\n\n```\n\n## Configuration File\n\nComigo supports  configuration file locations:\n\n1. **User Home Directory**  \n   - Windows: `C:\\Users\\username\\.config\\comigo.toml`\n   - Linux/MacOS: `/home/username/.config/comigo.toml`\n   - Default location read at startup\n\n2. **Program Directory**  \n   - Place `comigo.toml` in the same directory as the executable\n   - Suitable for portable usage\n\n3. **Current Working Directory**  \n   - Searches for configuration file in the current directory when running commands\n\n4. **Custom Location**  \n   - Specify configuration file path using the `--config` parameter\n\n## Feedback and Support\n\nIf you have any suggestions or encounter issues, feel free to:\n- Submit an [Issue](https://github.com/yumenaka/comigo/issues)\n- Contact me via [Twitter](https://x.com/yumenaka7)\n- Join the discussion on [Discord](https://discord.gg/c5q6d3dM8r)\n## Special Thanks\n\nThanks to the following open-source projects and their contributors:\n- [mholt](https://github.com/mholt)\n- [spf13](https://github.com/spf13)\n- [disintegration](https://github.com/disintegration)\n- [Baozisoftware](https://github.com/Baozisoftware)\n- And many more contributors\n\n## Project Statistics\n\n[![Stargazers over time](https://starchart.cc/yumenaka/comigo.svg?variant=adaptive)](https://starchart.cc/yumenaka/comigo)\n\n## License\n\nThis software is released under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyumenaka%2Fcomigo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyumenaka%2Fcomigo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyumenaka%2Fcomigo/lists"}