NP-DEPRECATE
Section: (1)
Updated: October 2025
Index
Return to Main Contents
NAME
np-deprecate- Deprecate a version of a package
Synopsis
-
npm deprecate <packag-spec> <message>
Note: This command is unaware of workspaces.
Description
This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it.
It works on
version ranges lahttps://semver.npmjs.com/ra as well as specific versions, so you can do something like this:
-
npm deprecate m-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
SemVer ranges passed to this command are interpreted such that they
do include prerelease versions. For example:
-
npm deprecate m-thing@1.x "1.x is no longer supported"
In this case, a version
m-thing@1.0.-beta.0 will also be deprecated.
You must be the package owner to deprecate something. See the
owner and
adduser help topics.
To u-deprecate a package, specify an empty string (
"") for the
message argument. Note that you must use double quotes with no space between them to format an empty string.
Configuration
registry
-
- *
-
Default: "https://registry.npmjs.org/"
- *
-
Type: URL
The base URL of the npm registry.
otp
-
- *
-
Default: null
- *
-
Type: null or String
This is a on-time password from a tw-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 on-time password, npm will prompt on the command line for one.
dr-run
-
- *
-
Default: false
- *
-
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 dis-tags, owner, etc.
See Also
-
- *
-
npm help "package spec"
- *
-
npm help publish
- *
-
npm help registry
- *
-
npm help owner
- *
-
npm help adduser
Index
- NAME
-
- Synopsis
-
- Description
-
- Configuration
-
- registry
-
- otp
-
- dry-run
-
- See Also
-