Nextflow: nf-lamin

nf-lamin is a Nextflow plugin that records data lineage for your workflows in LaminHub. Without modifying pipeline code, it tracks transforms, runs, and artifacts.

Quickstart

Option A: environment variables (no config file needed):

export LAMIN_CURRENT_INSTANCE="your-org/your-instance"
export LAMIN_API_KEY="<your-lamin-api-key>"
nextflow run -plugins nf-lamin@0.8.1 <your-pipeline>

Option B: Nextflow secrets + config file:

Store your API key as a Nextflow secret:

nextflow secrets set LAMIN_API_KEY <your-lamin-api-key>

Create a lamin.config file:

plugins {
  id 'nf-lamin'
}

lamin {
  instance = "your-org/your-instance"
  api_key = secrets.LAMIN_API_KEY
}

Then run your pipeline with the config:

nextflow run <your-pipeline> -c lamin.config

Version compatibility

nf-lamin	LaminDB	Nextflow	Status	Key Features
0.8.2	>= 2.0	>= 25.10.0	✅ Supported	Parallellized artifact creation
0.8.1	>= 2.0	>= 25.10.0	✅ Supported	Improved trace logging
0.8.0	>= 2.0	>= 25.10.0	✅ Supported	Support for Nextflow 26.04, fix key resolution, deprecate uploading local paths
0.7.0	>= 2.0	>= 25.10.0	❌ Unsupported	Automatic credential federation for lamin:// URIs (S3)
0.6.2	>= 2.0	>= 25.10.0	❌ Unsupported	Fix deferred param evaluation, documentation improvements
0.6.1	>= 2.0	>= 25.10.0	❌ Unsupported	Fix for edge case in tracking output artifacts
0.6.0	>= 2.0	>= 25.10.0	❌ Unsupported	Relativize keys, specify artifact paths, support space and branch
0.5.1	>= 2.0	>= 25.10.0	❌ Unsupported	Track local input files, exclude work and assets directories
0.5.0	>= 2.0	>= 25.10.0	❌ Unsupported	Improved config, artifact tracking rules, metadata tagging
0.4.0	>= 2.0	>= 25.10.0	❌ Unsupported	Input artifact tracking
0.3.0	>= 2.0	>= 25.04.0	❌ Unsupported	Upgrade to LaminDB v2, lamin:// URI support
0.2.x	>= 1.0, < 2.0	>= 25.04.0	❌ Unsupported	Reports, getRunUid(), getTransformUid(), getInstanceSlug()
0.1.0	>= 1.0, < 2.0	>= 24.04.0	❌ Unsupported	Transform & Run tracking, output artifact registration