Skip to main content

newman CLI reference

ModularPipelines.Newman provides strongly typed access to the newman CLI.

Executable prerequisite​

This package does not install the newman executable. Install it separately and ensure newman is available on PATH.

Follow the executable's official documentation for installation instructions.

Package installation​

dotnet add package ModularPipelines.Newman

Resolve the service with context.Tools.Newman. Projects using C# 13 or another .NET language can use context.Tools.Get<ModularPipelines.Newman.Services.INewman>() instead.

Module example​

Resolve the service in a module, then select a command from the table below. Unsafe or destructive commands do not receive runnable examples:

var newman = context.Tools.Newman;

Commands​

CLI commandOptions record
newman runNewmanRunOptions