pnpm CLI reference

ModularPipelines.Node provides strongly typed access to the pnpm CLI.

Executable prerequisite

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

Follow the executable's official documentation for installation instructions.

Package installation

dotnet add package ModularPipelines.Node

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

Module example

using ModularPipelines;
using ModularPipelines.Node.Enums;
using ModularPipelines.Node.Options;

public class RunCommandModule : Module<CommandResult>
{
    protected override async Task<CommandResult> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Tools.Pnpm.AuditAsync(
            new PnpmAuditOptions()
            {
                AuditLevel = PnpmAuditAuditLevel.High,
            },
            cancellationToken: cancellationToken);
    }
}

Intentionally excluded commands

CLI command	Reason
pnpm audit signatures	pnpm 12.4.1 no longer lists this path in a Commands section or exposes a distinct child synopsis. The parent command documents [PARAMS]... instead; use its generated Params operand.
pnpm stage approve	pnpm 12.4.1 no longer lists this path in a Commands section or exposes a distinct child synopsis. The parent command documents [PARAMS]... instead; use its generated Params operand.
pnpm stage download	pnpm 12.4.1 no longer lists this path in a Commands section or exposes a distinct child synopsis. The parent command documents [PARAMS]... instead; use its generated Params operand.
pnpm stage list	pnpm 12.4.1 no longer lists this path in a Commands section or exposes a distinct child synopsis. The parent command documents [PARAMS]... instead; use its generated Params operand.
pnpm stage publish	pnpm 12.4.1 no longer lists this path in a Commands section or exposes a distinct child synopsis. The parent command documents [PARAMS]... instead; use its generated Params operand.
pnpm stage reject	pnpm 12.4.1 no longer lists this path in a Commands section or exposes a distinct child synopsis. The parent command documents [PARAMS]... instead; use its generated Params operand.
pnpm stage view	pnpm 12.4.1 no longer lists this path in a Commands section or exposes a distinct child synopsis. The parent command documents [PARAMS]... instead; use its generated Params operand.

Commands

CLI command	Options record
pnpm access	PnpmAccessOptions
pnpm add	PnpmAddOptions
pnpm approve-builds	PnpmApproveBuildsOptions
pnpm audit	PnpmAuditOptions
pnpm bugs	PnpmBugsOptions
pnpm cache	PnpmCacheOptions
pnpm cache delete	PnpmCacheDeleteOptions
pnpm cache list	PnpmCacheListOptions
pnpm cache list-registries	PnpmCacheListRegistriesOptions
pnpm cache path	PnpmCachePathOptions
pnpm cache view	PnpmCacheViewOptions
pnpm cat-file	PnpmCatFileOptions
pnpm cat-index	PnpmCatIndexOptions
pnpm change	PnpmChangeOptions
pnpm ci	PnpmCiOptions
pnpm clean	PnpmCleanOptions
pnpm config	PnpmConfigOptions
pnpm config delete	PnpmConfigDeleteOptions
pnpm config get	PnpmConfigGetOptions
pnpm config list	PnpmConfigListOptions
pnpm config set	PnpmConfigSetOptions
pnpm create	PnpmCreateOptions
pnpm dedupe	PnpmDedupeOptions
pnpm deploy	PnpmDeployOptions
pnpm deprecate	PnpmDeprecateOptions
pnpm dist-tag	PnpmDistTagOptions
pnpm dlx	PnpmDlxOptions
pnpm docs	PnpmDocsOptions
pnpm doctor	PnpmDoctorOptions
pnpm edit	PnpmEditOptions
pnpm exec	PnpmExecOptions
pnpm fetch	PnpmFetchOptions
pnpm find-hash	PnpmFindHashOptions
pnpm get	PnpmGetOptions
pnpm ignored-builds	PnpmIgnoredBuildsOptions
pnpm import	PnpmImportOptions
pnpm init	PnpmInitOptions
pnpm install	PnpmInstallOptions
pnpm install-test	PnpmInstallTestOptions
pnpm lane	PnpmLaneOptions
pnpm licenses	PnpmLicensesOptions
pnpm link	PnpmLinkOptions
pnpm list	PnpmListOptions
pnpm ll	PnpmLlOptions
pnpm login	PnpmLoginOptions
pnpm logout	PnpmLogoutOptions
pnpm outdated	PnpmOutdatedOptions
pnpm owner	PnpmOwnerOptions
pnpm pack	PnpmPackOptions
pnpm pack-app	PnpmPackAppOptions
pnpm patch	PnpmPatchOptions
pnpm patch-commit	PnpmPatchCommitOptions
pnpm patch-remove	PnpmPatchRemoveOptions
pnpm peers	PnpmPeersOptions
pnpm ping	PnpmPingOptions
pnpm pipeline	PnpmPipelineOptions
pnpm pkg	PnpmPkgOptions
pnpm pkg delete	PnpmPkgDeleteOptions
pnpm pkg fix	PnpmPkgFixOptions
pnpm pkg get	PnpmPkgGetOptions
pnpm pkg set	PnpmPkgSetOptions
pnpm prefix	PnpmPrefixOptions
pnpm profile	PnpmProfileOptions
pnpm prune	PnpmPruneOptions
pnpm publish	PnpmPublishOptions
pnpm purge	PnpmPurgeOptions
pnpm rebuild	PnpmRebuildOptions
pnpm recursive	PnpmRecursiveOptions
pnpm remove	PnpmRemoveOptions
pnpm repo	PnpmRepoOptions
pnpm restart	PnpmRestartOptions
pnpm run	PnpmRunOptions
pnpm runtime	PnpmRuntimeOptions
pnpm sbom	PnpmSbomOptions
pnpm search	PnpmSearchOptions
pnpm self-update	PnpmSelfUpdateOptions
pnpm set	PnpmSetOptions
pnpm set-script	PnpmSetScriptOptions
pnpm setup	PnpmSetupOptions
pnpm shim	PnpmShimOptions
pnpm stage	PnpmStageOptions
pnpm star	PnpmStarOptions
pnpm stars	PnpmStarsOptions
pnpm start	PnpmStartOptions
pnpm stop	PnpmStopOptions
pnpm store	PnpmStoreOptions
pnpm store add	PnpmStoreAddOptions
pnpm store path	PnpmStorePathOptions
pnpm store prune	PnpmStorePruneOptions
pnpm store status	PnpmStoreStatusOptions
pnpm team	PnpmTeamOptions
pnpm test	PnpmTestOptions
pnpm token	PnpmTokenOptions
pnpm undeprecate	PnpmUndeprecateOptions
pnpm unlink	PnpmUnlinkOptions
pnpm unpublish	PnpmUnpublishOptions
pnpm unstar	PnpmUnstarOptions
pnpm update	PnpmUpdateOptions
pnpm view	PnpmViewOptions
pnpm whoami	PnpmWhoamiOptions
pnpm why	PnpmWhyOptions
pnpm with	PnpmWithOptions
pnpm xmas	PnpmXmasOptions