Pnpm aliases

Cake.Pnpm addin

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Pnpm.

Pnpm Install aliases

Add

PnpmAdd(PnpmAddSettings) Alias from Cake.Pnpm addin	Install package using the specified settings
PnpmAdd(string, Action<PnpmAddSettings>) Alias from Cake.Pnpm addin	Install package using the settings returned by a configurator.
PnpmAdd(string) Alias from Cake.Pnpm addin	Install package

Audit

PnpmAudit(Action<PnpmAuditSettings>) Alias from Cake.Pnpm addin	Checks for known security issues with the installed packages using the settings returned by a configurator.
PnpmAudit(PnpmAuditSettings) Alias from Cake.Pnpm addin	Checks for known security issues with the installed packages using the specified settings
PnpmAudit() Alias from Cake.Pnpm addin	Checks for known security issues with the installed packages.

Exec

PnpmExec(string, PnpmExecSettings) Alias from Cake.Pnpm addin	Run a shell command in the context of a project using the specified settings
PnpmExec(string) Alias from Cake.Pnpm addin	Run a shell command in the context of a project

Import

PnpmImport() Alias from Cake.Pnpm addin	Generates pnpm-lock.yaml from an npm package-lock.json (or npm-shrinkwrap.json, yarn.lock) file. Visit https://pnpm.io/7.x/cli/import for documentation about this command.

Install

PnpmInstall(Action<PnpmInstallSettings>) Alias from Cake.Pnpm addin	Install packages using the settings returned by a configurator.
PnpmInstall(PnpmInstallSettings) Alias from Cake.Pnpm addin	Install packages using the specified settings
PnpmInstall() Alias from Cake.Pnpm addin	Installs packages for the project in the current working directory.

Licenses

PnpmLicenses(Action<PnpmLicensesSettings>) Alias from Cake.Pnpm addin	Check the licenses of the installed packages using the settings returned by a configurator.
PnpmLicenses(PnpmLicensesSettings) Alias from Cake.Pnpm addin	Check the licenses of the installed packages using the specified settings
PnpmLicenses() Alias from Cake.Pnpm addin	Check the licenses of the installed packages.

Link

PnpmLink(PnpmLinkSettings) Alias from Cake.Pnpm addin	Connect the local project to another one using the specified settings
PnpmLink(string, Action<PnpmLinkSettings>) Alias from Cake.Pnpm addin	Connect the local project to another one using the settings returned by a configurator.
PnpmLink(string) Alias from Cake.Pnpm addin	Connect the local project to another one

List

PnpmList(Action<PnpmListSettings>, string[]) Alias from Cake.Pnpm addin	Connect the local project to another one using the settings returned by a configurator.
PnpmList(PnpmListSettings) Alias from Cake.Pnpm addin	Connect the local project to another one using the specified settings
PnpmList(string[]) Alias from Cake.Pnpm addin	Connect the local project to another one
PnpmRebuild(PnpmRebuildSettings) Alias from Cake.Pnpm addin	Rebuild a package(s) using the specified settings

Outdated

PnpmOutdated(Action<PnpmOutdatedSettings>, string[]) Alias from Cake.Pnpm addin	Check for outdated packages using the settings returned by a configurator.
PnpmOutdated(PnpmOutdatedSettings) Alias from Cake.Pnpm addin	Check for outdated packages using the specified settings
PnpmOutdated(string[]) Alias from Cake.Pnpm addin	Check for outdated packages

Prune

PnpmPrune(Action<PnpmPruneSettings>) Alias from Cake.Pnpm addin	Removes extraneous packages using the settings returned by a configurator.
PnpmPrune(PnpmPruneSettings) Alias from Cake.Pnpm addin	Removes extraneous packages using the specified settings
PnpmPrune() Alias from Cake.Pnpm addin	Removes extraneous packages

Rebuild

PnpmRebuild(Action<PnpmRebuildSettings>, string[]) Alias from Cake.Pnpm addin	Rebuild a package(s) using the settings returned by a configurator.
PnpmRebuild(string[]) Alias from Cake.Pnpm addin	Rebuild a package(s)

Remove

PnpmRemove(PnpmRemoveSettings) Alias from Cake.Pnpm addin	Remove package using the specified settings
PnpmRemove(string, Action<PnpmRemoveSettings>) Alias from Cake.Pnpm addin	Remove package using the settings returned by a configurator.
PnpmRemove(string) Alias from Cake.Pnpm addin	Remove package

Run

PnpmRun(string, PnpmRunSettings) Alias from Cake.Pnpm addin	Runs a defined package script using the specified settings
PnpmRun(string) Alias from Cake.Pnpm addin	Runs a defined package script.
PnpmStart() Alias from Cake.Pnpm addin	Runs an arbitrary command specified in the package's "start" property of its "scripts" object
PnpmTest() Alias from Cake.Pnpm addin	Runs a package's "test" script, if one was provided

Store

PnpmStoreAdd(string[]) Alias from Cake.Pnpm addin	Adds new packages to the store. Example: pnpm store add express@4 typescript@2.1.0
PnpmStorePath() Alias from Cake.Pnpm addin	Returns the path to the active store directory.
PnpmStorePrune() Alias from Cake.Pnpm addin	Removes unreferenced (extraneous, orphan) packages from the store. Pruning the store is not harmful, but might slow down future installations. Visit the documentation for more information on unreferenced packages
PnpmStoreStatus() Alias from Cake.Pnpm addin	Checks for modified packages in the store. Returns exit code 0 if the content of the package is the same as it was at the time of unpacking

Unlink

PnpmUnlink(PnpmUnlinkSettings) Alias from Cake.Pnpm addin	Removes the link created by `pnpm link` and reinstalls package if it is saved in `package.json` using the specified settings
PnpmUnlink(string, Action<PnpmUnlinkSettings>) Alias from Cake.Pnpm addin	Removes the link created by `pnpm link` and reinstalls package if it is saved in `package.json` using the settings returned by a configurator.
PnpmUnlink(string) Alias from Cake.Pnpm addin	Removes the link created by `pnpm link` and reinstalls package if it is saved in `package.json`

Update

PnpmUpdate(Action<PnpmUpdateSettings>, string[]) Alias from Cake.Pnpm addin	Updates packages using the settings returned by a configurator
PnpmUpdate(PnpmUpdateSettings) Alias from Cake.Pnpm addin	Updates packages using the specified settings
PnpmUpdate(string[]) Alias from Cake.Pnpm addin	Updates packages to their latest version