Skip to content

Installation

This page gets NPipeline into your .NET project. You need one package to start; everything else is optional.

Requirements

  • .NET 8.0, 9.0, or 10.0
  • A C# project (console app, ASP.NET Core, worker service, etc.)

Install the Core Package

bash
dotnet add package NPipeline

This gives you the pipeline builder, all base node types, data streams, and the pipeline runner. It's everything you need to define and execute pipelines.

Most projects benefit from automatic node discovery and DI integration:

bash
dotnet add package NPipeline.Extensions.DependencyInjection

With this package, NPipeline scans your assemblies for nodes and pipeline definitions, then registers them in your DI container automatically.

Verify Your Setup

Create a new console project and confirm everything works:

bash
dotnet new console -n MyPipeline
cd MyPipeline
dotnet add package NPipeline
dotnet add package NPipeline.Extensions.DependencyInjection
dotnet build

If the build succeeds, you're ready to write your first pipeline.

Optional Packages

Install these as you need them. You don't need any of these to get started.

PackagePurpose
NPipeline.Extensions.ParallelismRun nodes in parallel with thread-safety controls
NPipeline.Extensions.TestingIn-memory sources/sinks and test harness utilities
NPipeline.Extensions.Testing.AwesomeAssertionsAwesomeAssertions integration for pipeline tests
NPipeline.Extensions.Testing.FluentAssertionsFluentAssertions integration for pipeline tests
NPipeline.Extensions.LineageData lineage tracking and provenance
NPipeline.Extensions.ObservabilityMetrics collection and monitoring
NPipeline.Extensions.CompositionNested sub-pipelines as reusable nodes
NPipeline.Connectors.CsvRead/write CSV files
NPipeline.Connectors.JsonRead/write JSON and NDJSON files
NPipeline.Connectors.ExcelRead/write XLS and XLSX files
NPipeline.Connectors.DuckDBEmbedded analytical SQL over Parquet/CSV/JSON
NPipeline.Connectors.ParquetRead/write Apache Parquet files

🔗 See also: Extensions for the complete list of all available packages.

Next Steps

Released under the MIT License.