CLI Reference

CLI Reference

GoldenMatch provides 23 CLI commands via goldenmatch <command>. All commands support --help.

pip install goldenmatch
goldenmatch --version

match

Match a target file against reference files.

goldenmatch match targets.csv --against reference.csv --config config.yaml --output-all

tui / interactive

Launch the interactive terminal UI.

goldenmatch interactive customers.csv
goldenmatch interactive customers.csv --config config.yaml

incremental

Match new CSV records against an existing base dataset.

goldenmatch incremental base.csv --new new_records.csv --config config.yaml

Handles exact matchkeys via Polars join and fuzzy matchkeys via match_one brute-force.

label

Build ground truth by labeling record pairs interactively. Type y (match), n (no match), or s (skip).

goldenmatch label customers.csv --config config.yaml --gt ground_truth.csv

mcp-serve

Start the MCP server for Claude Desktop integration.

goldenmatch mcp-serve --file customers.csv --config config.yaml

See MCP for tool details.

explain

Explain why two records matched.

goldenmatch explain ID_A ID_B --run-dir results/

rollback

Undo a previous merge run.

goldenmatch rollback RUN_ID --run-dir results/

runs

List previous runs available for rollback.

goldenmatch runs --run-dir results/

anomaly

Detect fake emails, placeholder data, and suspicious records.

goldenmatch anomaly customers.csv

dashboard

Generate a before/after data quality dashboard.

goldenmatch dashboard --run-dir results/ --output dashboard.html

watch

Watch a database table and match new records continuously.

goldenmatch watch --table customers --connection-string "$DATABASE_URL" --interval 30

# Daemon mode with health endpoint and PID file
goldenmatch watch --table customers --connection-string "$DATABASE_URL" --daemon

Common flags

Flag	Available On	Description
--config, -c	dedupe, match	Path to YAML config file
--output-all	dedupe, match	Write golden, dupes, unique, lineage
--output-dir	dedupe, match	Output directory
--llm-scorer	dedupe	Enable LLM scoring for borderline pairs
--llm-boost	dedupe	LLM-labeled training + fine-tuning
--backend ray	dedupe, match	Use Ray distributed backend
--preview	dedupe	Show merge preview before writing
--anomalies	dedupe	Run anomaly detection
--dashboard	dedupe	Generate HTML dashboard
--html-report	dedupe	Generate HTML match report
--diff	dedupe	Generate diff report
--chunked	dedupe	Process in chunks for large files