The command line

You do not need this page. The Dashboard runs every step below when you press Start scan (Add a folder). Use the command line for scripts, for a server, or if you like to work in a terminal.

The steps

Each step is one command. The example project is called hela, and its data folder is 20261012_HeLa_DAPI-GFP.

ingence init ~/ingence-projects/hela --root ~/Documents/20261012_HeLa_DAPI-GFP
ingence index -p ~/ingence-projects/hela
ingence dive  -p ~/ingence-projects/hela
ingence infer -p ~/ingence-projects/hela
ingence see   -p ~/ingence-projects/hela
  • init makes the project. --root names a data folder. Add one --root for each data folder.

  • index lists every file with its name, size and dates. It doesn’t open any file. It also splits each name into words and looks each word up in the Dictionary.

  • dive reads the contents of your files, one file type at a time. --budget is its time limit, in seconds. Ingence marks the files it did not reach “not read yet”. Run it again to go on.

  • infer applies the rules to what Ingence read. Each result names the rule that made it.

  • see opens the Dashboard on the project. Press Ctrl-C in the terminal to stop it.

index, dive and infer each end with what they found and the next command to run. ingence init --help lists the other options. For example, ingence init --depth metadata makes a project that reads names, sizes and dates only. Use it for a folder that is someone else’s (Read someone else’s folder). A project made with ingence init has the landing page’s date range. Ingence reads a number in a name as a date only if its year is from 2013 to this year. The setting dictionary.years changes this range (Teaching Ingence your words).

A practice folder

This makes a small folder with the files of two invented imaging experiments. The names look like real names: a date, a cell line, a treatment and a number.

mkdir ingence-tutorial && cd ingence-tutorial
mkdir -p practice-lab/20261012_HeLa_DAPI-GFP practice-lab/20261019_HeLa_DAPI-GFP practice-lab/scripts
printf 'TIFF stand-in\n' > practice-lab/20261012_HeLa_DAPI-GFP/20261012_HeLa_DMSO_001.tif
printf 'TIFF stand-in\n' > practice-lab/20261012_HeLa_DAPI-GFP/20261012_HeLa_DMSO_002.tif
printf 'cell,GFP,DAPI\n1,0.41,0.88\n2,0.44,0.91\n3,0.39,0.86\n' > practice-lab/20261012_HeLa_DAPI-GFP/20261012_HeLa_DMSO_quant.csv
printf 'Imaged on the confocal. Control wells only.\n' > practice-lab/20261012_HeLa_DAPI-GFP/notes.txt
printf 'TIFF stand-in\n' > practice-lab/20261019_HeLa_DAPI-GFP/20261019_HeLa_DMSO_001.tif
printf 'cell,GFP,DAPI\n1,0.61,0.84\n2,0.58,0.83\n' > practice-lab/20261019_HeLa_DAPI-GFP/20261019_HeLa_DMSO_quant.csv
printf 'import csv\n\n# average GFP per cell\n' > practice-lab/scripts/quantify_gfp.py
New-Item -ItemType Directory ingence-tutorial | Out-Null
Set-Location ingence-tutorial
New-Item -ItemType Directory practice-lab\20261012_HeLa_DAPI-GFP, practice-lab\20261019_HeLa_DAPI-GFP, practice-lab\scripts | Out-Null
Set-Content practice-lab\20261012_HeLa_DAPI-GFP\20261012_HeLa_DMSO_001.tif "TIFF stand-in"
Set-Content practice-lab\20261012_HeLa_DAPI-GFP\20261012_HeLa_DMSO_002.tif "TIFF stand-in"
Set-Content practice-lab\20261012_HeLa_DAPI-GFP\20261012_HeLa_DMSO_quant.csv "cell,GFP,DAPI","1,0.41,0.88","2,0.44,0.91","3,0.39,0.86"
Set-Content practice-lab\20261012_HeLa_DAPI-GFP\notes.txt "Imaged on the confocal. Control wells only."
Set-Content practice-lab\20261019_HeLa_DAPI-GFP\20261019_HeLa_DMSO_001.tif "TIFF stand-in"
Set-Content practice-lab\20261019_HeLa_DAPI-GFP\20261019_HeLa_DMSO_quant.csv "cell,GFP,DAPI","1,0.61,0.84","2,0.58,0.83"
Set-Content practice-lab\scripts\quantify_gfp.py "import csv","","# average GFP per cell"

The .tif files are stand-ins. Each holds one line of text, and it doesn’t hold a picture. Then run the steps on the practice folder:

ingence init project --root practice-lab
ingence index -p project
ingence dive -p project
ingence infer -p project
ingence see -p project

Ingence finds 2 experiments, one for each dated folder. You can delete the ingence-tutorial folder when you are done.

A larger invented folder

ingence demo makes the sample laboratory, scans it and opens it. To make the same files without a project, run this in the environment where Ingence is installed:

python -m ingence.evaluation sample-lab sample-collection --tier S --seed 1

Then use its pool folder as the data folder.

Apply your changes from the command line

The Dashboard’s Re-run applies your answers and corrections. By hand, it takes two steps. First, ingence index --rebind -p PROJECT reads the saved names again and doesn’t open any file. Then ingence infer -p PROJECT applies the rules again.

The other commands

Ingence has other commands: rule, teach, record, export, fix and mcp. They show the rules and the Dictionary, import answers, write tables and summaries, and check a project. mcp answers questions from another program about one project (Use Ingence with an AI agent). log and map are not built yet. The command reference lists every command and option.