npm-publish - Publish a package Synopsis npm publish [<folder>] Description Publishes a package to the registry so that it can be installed by name. By default npm will publish to the public registry. This can be over- ridden by specifying a different default registry or using a npm help scope in the name (see npm help package.json). o <folder>: A folder containing a package.json file o <tarball>: A url or file path to a gzipped tar archive containing a single folder with a package.json file inside. o [--tag <tag>]: Registers the published package with the given tag, such that npm install <name>@<tag> will install this version. By default, npm publish updates and npm install installs the latest tag. See npm-dist-tag npm-dist-tag for details about tags. o [--access <public|restricted>]: Tells the registry whether this pack- age should be published as public or restricted. Only applies to scoped packages, which default to restricted. If you don't have a paid account, you must publish with --access public to publish scoped packages. o [--otp <otpcode>]: If you have two-factor authentication enabled in auth-and-writes mode then you can provide a code from your authenti- cator with this. If you don't include this and you're running from a TTY then you'll be prompted. o [--dry-run]: As of npm@6, does everything publish would do except actually publishing to the registry. Reports the details of what would have been published. o [--workspaces]: Enables workspace context while publishing. All workspace packages will be published. o [--workspace]: Enables workspaces context and limits results to only those specified by this config item. Only the packages in the workspaces given will be published. The publish will fail if the package name and version combination already exists in the specified registry. Once a package is published with a given name and version, that spe- cific name and version combination can never be used again, even if it is removed with npm help unpublish. As of npm@5, both a sha1sum and an integrity field with a sha512sum of the tarball will be submitted to the registry during publication. Sub- sequent installs will use the strongest supported algorithm to verify downloads. Similar to --dry-run see npm help pack, which figures out the files to be included and packs them into a tarball to be uploaded to the reg- istry. Files included in package To see what will be included in your package, run npx npm-packlist. All files are included by default, with the following exceptions: o Certain files that are relevant to package installation and distribu- tion are always included. For example, package.json, README.md, LICENSE, and so on. o If there is a "files" list in npm help package.json, 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.) o If there is a .gitignore or .npmignore file, then ignored files in that and all child directories will be excluded from the package. If both files exist, then the .gitignore is ignored, and only the .npmignore is used. .npmignore files follow the same pattern rules https://git-scm.com/book/en/v2/Git-Basics-Record- ing-Changes-to-the-Repository#_ignoring as .gitignore files o If the file matches certain patterns, then it will never be included, unless explicitly added to the "files" list in package.json, or un-ignored with a ! rule in a .npmignore or .gitignore file. o Symbolic links are never included in npm packages. See npm help developers for full details on what's included in the pub- lished package, as well as details on how the package is built. Configuration tag o Default: "latest" o Type: String If you ask npm to install a package and don't tell it a specific ver- sion, then it will install the specified tag. Also the tag that is added to the package@version specified by the npm tag command, if no explicit tag is given. When used by the npm diff command, this is the tag used to fetch the tarball that will be compared with the local files by default. access o Default: 'restricted' for scoped packages, 'public' for unscoped packages o Type: null, "restricted", or "public" When publishing scoped packages, the access level defaults to restricted. If you want your scoped package to be publicly viewable (and installable) set --access=public. The only valid values for access are public and restricted. Unscoped packages always have an access level of public. Note: Using the --access flag on the npm publish command will only set the package access level on the initial publish of the package. Any subsequent npm publish commands using the --access flag will not have an effect to the access level. To make changes to the access level after the initial publish use npm access. dry-run o Default: false o Type: Boolean Indicates 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, install, update, dedupe, uninstall, as well as pack and publish. Note: This is NOT honored by other network related commands, eg dist-tags, owner, etc. otp o Default: null o Type: null or String This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with npm access. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. workspace o Default: o Type: String (can be set multiple times) Enable 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. Valid values for the workspace config are either: o Workspace names o Path to a workspace directory o Path to a parent workspace directory (will result in selecting all workspaces within that folder) When set for the npm init 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. This value is not exported to the environment for child processes. workspaces o Default: null o Type: null or Boolean Set to true to run the command in the context of all configured workspaces. Explicitly setting this to false will cause commands like install to ignore workspaces altogether. When not set explicitly: o Commands that operate on the node_modules tree (install, update, etc.) will link workspaces into the node_modules folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, unless one or more workspaces are specified in the workspace config. This value is not exported to the environment for child processes. include-workspace-root o Default: false o Type: Boolean Include the workspace root when workspaces are enabled for a command. When false, specifying individual workspaces via the workspace config, or all workspaces via the workspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project. This value is not exported to the environment for child processes. See Also o npm-packlist package http://npm.im/npm-packlist o npm help registry o npm help scope o npm help adduser o npm help owner o npm help deprecate o npm help dist-tag o npm help pack o npm help profile
Please see following description for synopsis
NPM-PUBLISH(1) NPM-PUBLISH(1)
NAME
npm-publish - Publish a package
Synopsis
npm publish [<folder>]
Description
Publishes a package to the registry so that it can be installed by
name.
By default npm will publish to the public registry. This can be over-
ridden by specifying a different default registry or using a npm help
scope in the name (see npm help package.json).
o <folder>: A folder containing a package.json file
o <tarball>: A url or file path to a gzipped tar archive containing a
single folder with a package.json file inside.
o [--tag <tag>]: Registers the published package with the given tag,
such that npm install <name>@<tag> will install this version. By
default, npm publish updates and npm install installs the latest tag.
See npm-dist-tag npm-dist-tag for details about tags.
o [--access <public|restricted>]: Tells the registry whether this pack-
age should be published as public or restricted. Only applies to
scoped packages, which default to restricted. If you don't have a
paid account, you must publish with --access public to publish scoped
packages.
o [--otp <otpcode>]: If you have two-factor authentication enabled in
auth-and-writes mode then you can provide a code from your authenti-
cator with this. If you don't include this and you're running from a
TTY then you'll be prompted.
o [--dry-run]: As of npm@6, does everything publish would do except
actually publishing to the registry. Reports the details of what
would have been published.
o [--workspaces]: Enables workspace context while publishing. All
workspace packages will be published.
o [--workspace]: Enables workspaces context and limits results to only
those specified by this config item. Only the packages in the
workspaces given will be published.
The publish will fail if the package name and version combination
already exists in the specified registry.
Once a package is published with a given name and version, that spe-
cific name and version combination can never be used again, even if it
is removed with npm help unpublish.
As of npm@5, both a sha1sum and an integrity field with a sha512sum of
the tarball will be submitted to the registry during publication. Sub-
sequent installs will use the strongest supported algorithm to verify
downloads.
Similar to --dry-run see npm help pack, which figures out the files to
be included and packs them into a tarball to be uploaded to the reg-
istry.
Files included in package
To see what will be included in your package, run npx npm-packlist.
All files are included by default, with the following exceptions:
o Certain files that are relevant to package installation and distribu-
tion are always included. For example, package.json, README.md,
LICENSE, and so on.
o If there is a "files" list in npm help package.json, 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.)
o If there is a .gitignore or .npmignore file, then ignored files in
that and all child directories will be excluded from the package. If
both files exist, then the .gitignore is ignored, and only the
.npmignore is used. .npmignore files follow the same pattern rules
https://git-scm.com/book/en/v2/Git-Basics-Record-
ing-Changes-to-the-Repository#_ignoring as .gitignore files
o If the file matches certain patterns, then it will never be included,
unless explicitly added to the "files" list in package.json, or
un-ignored with a ! rule in a .npmignore or .gitignore file.
o Symbolic links are never included in npm packages.
See npm help developers for full details on what's included in the pub-
lished package, as well as details on how the package is built.
Configuration
tag
o Default: "latest"
o Type: String
If you ask npm to install a package and don't tell it a specific ver-
sion, then it will install the specified tag.
Also the tag that is added to the package@version specified by the npm
tag command, if no explicit tag is given.
When used by the npm diff command, this is the tag used to fetch the
tarball that will be compared with the local files by default.
access
o Default: 'restricted' for scoped packages, 'public' for unscoped
packages
o Type: null, "restricted", or "public"
When publishing scoped packages, the access level defaults to
restricted. If you want your scoped package to be publicly viewable
(and installable) set --access=public. The only valid values for access
are public and restricted. Unscoped packages always have an access
level of public.
Note: Using the --access flag on the npm publish command will only set
the package access level on the initial publish of the package. Any
subsequent npm publish commands using the --access flag will not have
an effect to the access level. To make changes to the access level
after the initial publish use npm access.
dry-run
o Default: false
o Type: Boolean
Indicates 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, install,
update, dedupe, uninstall, as well as pack and publish.
Note: This is NOT honored by other network related commands, eg
dist-tags, owner, etc.
otp
o Default: null
o Type: null or String
This is a one-time password from a two-factor authenticator. It's
needed when publishing or changing package permissions with npm access.
If not set, and a registry response fails with a challenge for a
one-time password, npm will prompt on the command line for one.
workspace
o Default:
o Type: String (can be set multiple times)
Enable 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.
Valid values for the workspace config are either:
o Workspace names
o Path to a workspace directory
o Path to a parent workspace directory (will result in selecting all
workspaces within that folder)
When set for the npm init 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.
This value is not exported to the environment for child processes.
workspaces
o Default: null
o Type: null or Boolean
Set to true to run the command in the context of all configured
workspaces.
Explicitly setting this to false will cause commands like install to
ignore workspaces altogether. When not set explicitly:
o Commands that operate on the node_modules tree (install, update,
etc.) will link workspaces into the node_modules folder. - Commands
that do other things (test, exec, publish, etc.) will operate on the
root project, unless one or more workspaces are specified in the
workspace config.
This value is not exported to the environment for child processes.
include-workspace-root
o Default: false
o Type: Boolean
Include the workspace root when workspaces are enabled for a command.
When false, specifying individual workspaces via the workspace config,
or all workspaces via the workspaces flag, will cause npm to operate
only on the specified workspaces, and not on the root project.
This value is not exported to the environment for child processes.
See Also
o npm-packlist package http://npm.im/npm-packlist
o npm help registry
o npm help scope
o npm help adduser
o npm help owner
o npm help deprecate
o npm help dist-tag
o npm help pack
o npm help profile
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | runtime/nodejs/nodejs-18 |
+---------------+--------------------------+
|Stability | Pass-thru volatile |
+---------------+--------------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://github.com/nodejs/node/ar-
chive/v18.1.0.zip.
Further information about this software can be found on the open source
community website at https://github.com/nodejs/node.
April 2022 NPM-PUBLISH(1)