newman CLI reference

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

Installation

dotnet add package ModularPipelines.Newman

Resolve the service with context.Tools.Newman. For projects older than C# 14, import ModularPipelines.Newman.Extensions and use the context.Newman() extension method as a compatibility fallback.

Module example

using ModularPipelines.Context;
using ModularPipelines.Models;
using ModularPipelines.Modules;
using ModularPipelines.Newman.Options;

public class RunCommandModule : Module<CommandResult>
{
    protected override async Task<CommandResult> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Tools.Newman.UrlAsync(
            new NewmanUrlOptions(),
            cancellationToken: cancellationToken);
    }
}

Commands

CLI command	Options record
newman run	NewmanRunOptions
newman URL	NewmanUrlOptions