File Explorer

1.TH "NPM-PUBLISH" "1" "February 2026" "NPM@11.11.0" ""2.SH "NAME"3\fBnpm-publish\fR - Publish a package4.SS "Synopsis"5.P6.RS 27.nf8npm publish <package-spec>9.fi10.RE11.SS "Description"12.P13Publishes a package to the registry so that it can be installed by name.14.SS "Examples"15.P16Publish the package in the current directory:17.P18.RS 219.nf20npm publish21.fi22.RE23.P24Publish a specific workspace:25.P26.RS 227.nf28npm publish --workspace=<workspace-name>29.fi30.RE31.P32Publish multiple workspaces:33.P34.RS 235.nf36npm publish --workspace=workspace-a --workspace=workspace-b37.fi38.RE39.P40Publish all workspaces:41.P42.RS 243.nf44npm publish --workspaces45.fi46.RE47.P48By default npm will publish to the public registry. This can be overridden by specifying a different default registry or using a npm help scope in the name, combined with a scope-configured registry (see \fB\[rs]fBpackage.json\[rs]fR\fR \fI\(la/configuring-npm/package-json\(ra\fR).49.P50A \fBpackage\fR is interpreted the same way as other commands (like \fBnpm install\fR) and can be:51.RS 052.IP \(bu 453a) a folder containing a program described by a \fB\[rs]fBpackage.json\[rs]fR\fR \fI\(la/configuring-npm/package-json\(ra\fR file54.IP \(bu 455b) a gzipped tarball containing (a)56.IP \(bu 457c) a url that resolves to (b)58.IP \(bu 459d) a \fB<name>@<version>\fR that is published on the registry (see npm help registry) with (c)60.IP \(bu 461e) a \fB<name>@<tag>\fR (see npm help dist-tag) that points to (d)62.IP \(bu 463f) a \fB<name>\fR that has a "latest" tag satisfying (e)64.IP \(bu 465g) a \fB<git remote url>\fR that resolves to (a)66.RE 067 68.P69The publish will fail if the package name and version combination already exists in the specified registry.70.P71Once a package is published with a given name and version, that specific name and version combination can never be used again, even if it is removed with npm help unpublish.72.P73As of \fBnpm@5\fR, both a sha1sum and an integrity field with a sha512sum of the tarball will be submitted to the registry during publication. Subsequent installs will use the strongest supported algorithm to verify downloads.74.P75Similar to \fB--dry-run\fR see npm help pack, which figures out the files to be included and packs them into a tarball to be uploaded to the registry.76.SS "Files included in package"77.P78To see what will be included in your package, run \fBnpm pack --dry-run\fR. All files are included by default, with the following exceptions:79.RS 080.IP \(bu 481Certain files that are relevant to package installation and distribution are always included. For example, \fBpackage.json\fR, \fBREADME.md\fR, \fBLICENSE\fR, and so on.82.IP \(bu 483If there is a "files" list in \fB\[rs]fBpackage.json\[rs]fR\fR \fI\(la/configuring-npm/package-json\(ra\fR, then only the files specified will be included. (If directories are specified, then they will be walked recursively and their contents included, subject to the same ignore rules.)84.IP \(bu 485If there is a \fB.gitignore\fR or \fB.npmignore\fR file, then ignored files in that and all child directories will be excluded from the package. If \fIboth\fR files exist, then the \fB.gitignore\fR is ignored, and only the \fB.npmignore\fR is used.86.P87\fB.npmignore\fR files follow the \fBsame pattern rules\fR \fI\(lahttps://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring\(ra\fR as \fB.gitignore\fR files88.IP \(bu 489If the file matches certain patterns, then it will \fInever\fR be included, unless explicitly added to the \fB"files"\fR list in \fBpackage.json\fR, or un-ignored with a \fB!\fR rule in a \fB.npmignore\fR or \fB.gitignore\fR file.90.IP \(bu 491Symbolic links are never included in npm packages.92.RE 093 94.P95See npm help developers for full details on what's included in the published package, as well as details on how the package is built.96.P97See \fB\[rs]fBpackage.json\[rs]fR\fR \fI\(la/configuring-npm/package-json\(ra\fR for more info on what can and can't be ignored.98.SS "Configuration"99.SS "\fBtag\fR"100.RS 0101.IP \(bu 4102Default: "latest"103.IP \(bu 4104Type: String105.RE 0106 107.P108If you ask npm to install a package and don't tell it a specific version, then it will install the specified tag.109.P110It is the tag added to the package@version specified in the \fBnpm dist-tag111add\fR command, if no explicit tag is given.112.P113When used by the \fBnpm diff\fR command, this is the tag used to fetch the tarball that will be compared with the local files by default.114.P115If used in the \fBnpm publish\fR command, this is the tag that will be added to the package submitted to the registry.116.SS "\fBaccess\fR"117.RS 0118.IP \(bu 4119Default: 'public' for new packages, existing packages it will not change the current level120.IP \(bu 4121Type: null, "restricted", or "public"122.RE 0123 124.P125If you do not want your scoped package to be publicly viewable (and installable) set \fB--access=restricted\fR.126.P127Unscoped packages cannot be set to \fBrestricted\fR.128.P129Note: This defaults to not changing the current access level for existing packages. Specifying a value of \fBrestricted\fR or \fBpublic\fR during publish will change the access for an existing package the same way that \fBnpm access set130status\fR would.131.SS "\fBdry-run\fR"132.RS 0133.IP \(bu 4134Default: false135.IP \(bu 4136Type: Boolean137.RE 0138 139.P140Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, \fBinstall\fR, \fBupdate\fR, \fBdedupe\fR, \fBuninstall\fR, as well as \fBpack\fR and \fBpublish\fR.141.P142Note: This is NOT honored by other network related commands, eg \fBdist-tags\fR, \fBowner\fR, etc.143.SS "\fBotp\fR"144.RS 0145.IP \(bu 4146Default: null147.IP \(bu 4148Type: null or String149.RE 0150 151.P152This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with \fBnpm access\fR.153.P154If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.155.SS "\fBworkspace\fR"156.RS 0157.IP \(bu 4158Default:159.IP \(bu 4160Type: String (can be set multiple times)161.RE 0162 163.P164Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.165.P166Valid values for the \fBworkspace\fR config are either:167.RS 0168.IP \(bu 4169Workspace names170.IP \(bu 4171Path to a workspace directory172.IP \(bu 4173Path to a parent workspace directory (will result in selecting all workspaces within that folder)174.RE 0175 176.P177When set for the \fBnpm init\fR command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.178.P179This value is not exported to the environment for child processes.180.SS "\fBworkspaces\fR"181.RS 0182.IP \(bu 4183Default: null184.IP \(bu 4185Type: null or Boolean186.RE 0187 188.P189Set to true to run the command in the context of \fBall\fR configured workspaces.190.P191Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:192.RS 0193.IP \(bu 4194Commands that operate on the \fBnode_modules\fR tree (install, update, etc.) will link workspaces into the \fBnode_modules\fR folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, \fIunless\fR one or more workspaces are specified in the \fBworkspace\fR config.195.RE 0196 197.P198This value is not exported to the environment for child processes.199.SS "\fBinclude-workspace-root\fR"200.RS 0201.IP \(bu 4202Default: false203.IP \(bu 4204Type: Boolean205.RE 0206 207.P208Include the workspace root when workspaces are enabled for a command.209.P210When false, specifying individual workspaces via the \fBworkspace\fR config, or all workspaces via the \fBworkspaces\fR flag, will cause npm to operate only on the specified workspaces, and not on the root project.211.P212This value is not exported to the environment for child processes.213.SS "\fBprovenance\fR"214.RS 0215.IP \(bu 4216Default: false217.IP \(bu 4218Type: Boolean219.RE 0220 221.P222When publishing from a supported cloud CI/CD system, the package will be publicly linked to where it was built and published from.223.P224This config cannot be used with: \fBprovenance-file\fR225.SS "\fBprovenance-file\fR"226.RS 0227.IP \(bu 4228Default: null229.IP \(bu 4230Type: Path231.RE 0232 233.P234When publishing, the provenance bundle at the given path will be used.235.P236This config cannot be used with: \fBprovenance\fR237.SS "See Also"238.RS 0239.IP \(bu 4240npm help "package spec"241.IP \(bu 4242\fBnpm-packlist package\fR \fI\(lahttp://npm.im/npm-packlist\(ra\fR243.IP \(bu 4244npm help registry245.IP \(bu 4246npm help scope247.IP \(bu 4248npm help adduser249.IP \(bu 4250npm help owner251.IP \(bu 4252npm help deprecate253.IP \(bu 4254npm help dist-tag255.IP \(bu 4256npm help pack257.IP \(bu 4258npm help profile259.RE 0260