CBZOptimizer/docs/project-overview.md

Project Overview

CBZOptimizer is a Go CLI that optimizes comic archives (.cbz and .cbr) by converting page images to modern formats (currently WebP).

High-level flow

1. Load chapters from archive files.
2. Decode pages and optionally split oversized pages.
3. Convert images with the selected converter.
4. Write optimized output as CBZ.

Main components

• cmd/cbzoptimizer: CLI commands and flag wiring (optimize, watch).
• internal/cbz: archive loading and writing.
• internal/manga: chapter and page domain models.
• internal/utils: orchestration utilities (optimize flow and file helpers).
• pkg/converter: converter abstraction and format implementations.

Watch mode

watch monitors a directory tree for archive file changes and runs optimization automatically. By default it only reacts to changes going forward; pass --backfill to also optimize archives that already exist in the folder at startup.

Key runtime requirements

• Go 1.25+
• WebP encoder setup via cmd/encoder-setup for WebP conversion tests and runtime support.