CLI Reference

Overview

The indexer.py is the single CLI entry point for the project. It uses Python’s built-in argparse module.

indexer.py

Command format:

python indexer.py <vault_path> [--batch <size>]

Arguments

Argument	Short	Type	Required	Description
path	—	str	Yes	Path to the image vault directory
--batch	-b	int	No	Batch size for embedding inference (default: 8)

Examples

# Basic indexing of a vault
python indexer.py vault
 
# Index with larger batch for faster processing
python indexer.py vault --batch 16

api.py

Command format:

python api.py

No CLI arguments are supported. The API server binds to 127.0.0.1:8000 by default.

Exit Codes

Code	Condition
0	Successful execution
1	Unhandled exception (model load failure, DB error, etc.)

Related Components

• Image Indexing Pipeline – What the CLI drives
• Environment Configuration – Default values and paths

---

Last Updated: 2026-06-17