check

Scans a directory tree for image files, loads the nearest pixelartlint.toml for each file, and runs enabled rules. Violations print to stderr; the process exits with a non-zero code when any issue is found.

Syntax

Terminal
pixel-art-lint check [OPTIONS] [ROOT] [GLOBS]...

Arguments

  • ROOT (optional): folder to scan. Defaults to . (the current working directory).
  • -v: Verbose output logging, troubleshoots file system walking and loading.

Examples

Default scan

Terminal
pixel-art-lint check

Walks the current directory for .aseprite, PNG, and BMP files. Native Aseprite files are parsed in place so palette checks cover every layer and frame.

Custom root

Terminal
pixel-art-lint check ./assets/sprites

Config discovery

For each image, the tool walks parent directories until it finds pixelartlint.toml or reaches the filesystem root. If no config exists, a built-in default applies (palette checks are skipped until you define a palette section).

Output

When the palette rule fails, each file lists invalid colours with hex values and pixel counts. For PNG and BMP, the first offending pixel is shown as (x,y). For .aseprite files, violations also include the layer and frame index (zero-based, matching the file order) so you can jump straight to the cel in the editor.

PNG example
sprites/ui/hud_coin.png has invalid colours:
    #ff0033ff: 14 pixels (12,4)
Aseprite example
characters/player.aseprite has invalid colours:
    #ff0033ff: 3 pixels layer 2 frame 6 (0,0)

A summary line reports elapsed time and total issue count.