CLI Reference

VigilCV ships with a powerful terminal interface powered by Typer and Rich.

pip install vigilcv

vigilcv --help


vigilcv inspect

Inspect a single image and print a detailed quality report.

vigilcv inspect IMAGE_PATH [OPTIONS]
Arguments:
ArgumentDescription
IMAGE_PATHPath to the image file (JPEG, PNG, WEBP, BMP, TIFF)
Options:
OptionDefaultDescription
--blur-threshold100.0Minimum Laplacian variance
--min-entropy3.0Minimum Shannon entropy (bits)
--max-under0.20Max underexposure ratio
--max-over0.20Max overexposure ratio
--jsonFalseOutput as JSON
Example:
vigilcv inspect photo.jpg --blur-threshold 150 --json
Output:
{

"path": "photo.jpg",

"blur_score": 423.7,

"shannon_entropy": 6.12,

"underexposure_ratio": 0.03,

"overexposure_ratio": 0.01,

"passed": true,

"warnings": []

}


vigilcv audit

Audit all images in a directory with parallel workers.

vigilcv audit DIRECTORY [OPTIONS]
Options:
OptionDefaultDescription
--workers4Number of parallel threads
--reportNoneSave HTML dashboard to this path
--blur-threshold100.0Minimum Laplacian variance
--min-entropy3.0Minimum Shannon entropy
--max-under0.20Max underexposure ratio
--max-over0.20Max overexposure ratio
Example:
vigilcv audit dataset/train/ --workers 16 --report report.html
Terminal Output:
 VigilCV BatchAuditor

──────────────────────────────────────────

Total images : 12,847

Valid : 12,391 (96.5%)

Corrupted : 23

Blurred : 341

Underexposed : 82

Overexposed : 10

Throughput : 3,241 FPS

──────────────────────────────────────────

HTML report saved: report.html


vigilcv baseline

Compute and save a drift baseline from a reference dataset.

vigilcv baseline DIRECTORY --output BASELINE_PATH
Options:
OptionDefaultDescription
--outputbaseline.pklPath to save the baseline file
--workers4Parallel feature extraction threads
Example:
vigilcv baseline dataset/train/ --output baselines/production_v1.pkl

vigilcv drift

Detect distribution drift against a saved baseline.

vigilcv drift DIRECTORY --baseline BASELINE_PATH [OPTIONS]
Options:
OptionDefaultDescription
--baselineRequiredPath to .pkl baseline file
--threshold0.15Wasserstein-1 drift threshold
--workers4Parallel feature extraction threads
--jsonFalseOutput as JSON
Example:
vigilcv drift dataset/new_batch/ --baseline baselines/production_v1.pkl --threshold 0.20
Output:
 Drift Report

──────────────────────────────────────────

Status : DRIFTED

Wasserstein-1 : 0.287

MMD² : 0.00412

Reference N : 12,847

Query N : 1,200

Top features : channel_r_mean, spatial_q1_g_std, kurtosis_b