cargo CLI reference

ModularPipelines.Rust provides strongly typed access to the cargo CLI.

Executable prerequisite

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

Follow the executable's official documentation for installation instructions.

Package installation

dotnet add package ModularPipelines.Rust

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

Module example

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

public class RunCommandModule : Module<CommandResult>
{
    protected override async Task<CommandResult> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Tools.Cargo.CheckAsync(
            new CargoCheckOptions()
            {
                Quiet = true,
            },
            cancellationToken: cancellationToken);
    }
}

Commands

CLI command	Options record
cargo add	CargoAddOptions
cargo bench	CargoBenchOptions
cargo build	CargoBuildOptions
cargo check	CargoCheckOptions
cargo clean	CargoCleanOptions
cargo doc	CargoDocOptions
cargo init	CargoInitOptions
cargo install	CargoInstallOptions
cargo new	CargoNewOptions
cargo publish	CargoPublishOptions
cargo remove	CargoRemoveOptions
cargo run	CargoRunOptions
cargo search	CargoSearchOptions
cargo test	CargoTestOptions
cargo uninstall	CargoUninstallOptions
cargo update	CargoUpdateOptions