Skip to main content
The archeo-cluster CLI provides a set of commands for running archaeological image analysis — from object detection through clustering to spatial statistics. Every command is available through two equivalent entry points:
./run-cli --help
./run-cli <command> [options]

Global flags

--version
boolean
Print the current version and exit. Short alias: -v.
--verbose
boolean
Enable verbose (DEBUG-level) log output. Short alias: -V.

Commands

detect

Detect archaeological objects in images using color segmentation. Produces a features.csv and annotated output images.

cluster

Perform K-Means clustering on the features extracted by detect. Uses the elbow method to find the optimal number of clusters.

analyze

Run spatial analysis on clustered data using the Average Nearest Neighbor (ANN) index to identify distribution patterns.

pipeline

Run the complete detect → cluster → analyze pipeline in a single command. Recommended entry point for most analyses.

sessions

List and manage analysis sessions stored in the centralized session directory.

General usage pattern

Most analyses follow this three-stage flow:
Images  →  detect  →  features.csv
                  →  cluster  →  clustered.csv
                                         →  analyze  →  plots / ANN index
The pipeline command executes all three stages automatically and is the recommended starting point. Use the individual commands when you need to rerun a single stage or work with existing output files.
Run any command with --help to see all available options for that command.
./run-cli detect --help

Build docs developers (and LLMs) love