Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Zingg Command Line

The two CLI invocation patterns and copy-paste commands for every Zingg phase for Docker, local Spark, EMR, and CI/CD environments.

The CLI lets you invoke Zingg phases from any environment that has a terminal - Docker containers, local Spark installations, AWS EMR clusters, or CI/CD pipelines. No notebook required.

You can pass a JSON configuration file directly or point the CLI at a Python program to run. This means you can run Zingg Python programs through zingg.sh just as easily as JSON-configured jobs - the CLI is not a replacement for the Python API; it is the runtime that executes both.

The Two Invocation Patterns

Pass a JSON config file

./scripts/zingg.sh <optional --properties-file path to zingg.conf> --phase <phase> --conf <path to json>

Run a Python program

./scripts/zingg.sh <optional --properties-file path to zingg.conf> --run <path to python program>

Find training pairs

./scripts/zingg.sh --phase findTrainingData --conf config.json

Label pairs

The --showConcise=true flag shows only fields used for matching and hides DONT_USE fields.

./scripts/zingg.sh --phase label --conf config.json --showConcise=true

Train the model

./scripts/zingg.sh --phase train --conf config.json

Run match

match finds duplicates within a single dataset.

./scripts/zingg.sh --phase match --conf config.json

link matches records across two separate datasets.

./scripts/zingg.sh --phase link --conf config.json

Enterprise adds two phases not available in Community: generateDocs and runIncremental. Replace config.json with your actual config file path.

Find training pairs

./scripts/zingg.sh --phase findTrainingData --conf config.json

Label pairs

./scripts/zingg.sh --phase label --conf config.json --showConcise=true

Generate model documentation

Optional but recommended before train — lets you inspect training data quality before committing to the train phase.

./scripts/zingg.sh --phase generateDocs --conf config.json

Train the model

./scripts/zingg.sh --phase train --conf config.json

Run match

./scripts/zingg.sh --phase match --conf config.json
./scripts/zingg.sh --phase link --conf config.json

Run incremental

Updates the identity graph with new and changed records without re-running the full match.

generateDocs, runIncremental, and diff are Enterprise only phases.

What does a basic config.json look like?

The JSON config file tells Zingg which fields to use, where your data lives, and where to write output. Here is the minimum structure to run any phase:

Last updated

Was this helpful?