jq CLI reference

ModularPipelines.Jq provides strongly typed access to the jq CLI.

Installation

dotnet add package ModularPipelines.Jq

Import ModularPipelines.Jq.Extensions, then resolve the service with context.Jq().

Module example

using ModularPipelines.Context;
using ModularPipelines.Models;
using ModularPipelines.Modules;
using ModularPipelines.Jq.Extensions;
using ModularPipelines.Jq.Options;

public class RunCommandModule : Module<CommandResult>
{
    protected override async Task<CommandResult?> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Jq().Execute(
            new JqExecuteOptions(),
            cancellationToken: cancellationToken);
    }
}

Commands

CLI command	Options record
jq	JqExecuteOptions