pnpm publish

Publishes a package to the registry.

pnpm [-r] publish [<tarball|folder>] [--tag <tag>]
     [--access <public|restricted>] [options]

:::note

Since v11, pnpm publish is implemented natively and no longer delegates to the npm CLI. If you rely on a feature that is now gone, please open an issue at pnpm/pnpm. As a workaround, you can still run pnpm pack && npm publish *.tgz.

:::

When publishing a package inside a workspace, the LICENSE file from the root of the workspace is packed with the package (unless the package has a license of its own).

You may override some fields before publish, using the publishConfig field in package.json. You also can use the publishConfig.directory to customize the published subdirectory (usually using third party build tools).

When running this command recursively (pnpm -r publish), pnpm will publish all the packages that have versions not yet published to the registry.

Options#

--recursive, -r#

Publish all packages from the workspace.

--json#

Show information in JSON format.

--tag <tag>#

Publishes the package with the given tag. By default, pnpm publish updates the latest tag.

For example:

# inside the foo package directory
pnpm publish --tag next
# in a project where you want to use the next version of foo
pnpm add foo@next

--access <public|restricted>#

Tells the registry whether the published package should be public or restricted.

--no-git-checks#

Don't check if current branch is your publish branch, clean, and up-to-date with remote.

--publish-branch <branch>#

• Default: master and main
• Types: String

The primary branch of the repository which is used for publishing the latest changes.

--force#

Try to publish packages even if their current version is already found in the registry.

--batch#

Added in: v11.7.0

When publishing recursively (pnpm -r publish), send all selected packages to the registry in a single PUT /-/pnpm/v1/publish request instead of one request per package.

The target registry has to implement the batch publish endpoint (pnpr does); registries that don't are reported with an ERR_PNPM_BATCH_PUBLISH_UNSUPPORTED error. The batch is processed all-or-nothing: if any package in the batch fails validation, none of the packages are published.

--skip-manifest-obfuscation#

Added in: v11.3.0

Keep the original packageManager field and publish lifecycle scripts in the published manifest instead of stripping them. The pnpm-specific pnpm field is still omitted.

--report-summary#

Save the list of published packages to pnpm-publish-summary.json. Useful when some other tooling is used to report the list of published packages.

An example of a pnpm-publish-summary.json file:

{
  "publishedPackages": [
    {
      "name": "foo",
      "version": "1.0.0"
    },
    {
      "name": "bar",
      "version": "2.0.0"
    }
  ]
}

--dry-run#

Does everything a publish would do except actually publishing to the registry.

--otp#

When publishing packages that require two-factor authentication, this option can specify a one-time password.

You can also provide the OTP via the PNPM_CONFIG_OTP environment variable:

pnpm publish --no-git-checks

If the registry requests OTP and you have not provided it via the environment variable or the --otp flag, pnpm will prompt you directly for an OTP code.

If the registry requests web-based authentication, pnpm will print a scannable QR code along with the URL.

--provenance#

When publishing from a supported cloud CI/CD system, the package will be publicly linked to where it was built and published from.

--filter <package_selector>#

Read more about filtering.

Configuration#

You can also set gitChecks, publishBranch options in the pnpm-workspace.yaml file.

For example:

yaml title="pnpm-workspace.yaml" gitChecks: false publishBranch: production

Life Cycle Scripts#

• prepublishOnly
• prepublish
• prepack
• prepare
• postpack
• publish
• postpublish