Skip to content

CLI

The package installs a gitter command for optional terminal workflows. If gitter is not on your PATH, prefix commands with uv run.

Commands

gitter run

Process one image.

gitter run IMAGE.jpg --plate-format 1536 --out results.csv

Common options:

  • --plate-format 1536 or --plate-format ROWS,COLS
  • --remove-noise
  • --inverse
  • --contrast INT
  • --fast INT
  • --verbose l|p|n

For single-plate images like examples/extdata/sample.jpg, the CLI runs direct quantification.

For multi-plate images, use the Python API with PlateSplitter first, then run gitter(...) on the extracted plate crops.

gitter batch

Process a directory or multiple files.

gitter batch examples/extdata --ref-image-file examples/extdata/sample.jpg

gitter read

Show a CSV results summary.

gitter read sample.csv

gitter plot

Plot CSV results.

gitter plot sample.csv --plot-type heatmap --out sample.png