1NPM-DEPRECATE(1) NPM-DEPRECATE(1)
2
3
4
6 npm-deprecate - Deprecate a version of a package
7
8 Synopsis
9 npm deprecate <package-spec> <message>
10
11 Note: This command is unaware of workspaces.
12
13 Description
14 This command will update the npm registry entry for a package, provid‐
15 ing a deprecation warning to all who attempt to install it.
16
17 It works on version ranges ⟨https://semver.npmjs.com/⟩ as well as spe‐
18 cific versions, so you can do something like this:
19
20 npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
21
22 SemVer ranges passed to this command are interpreted such that they do
23 include prerelease versions. For example:
24
25 npm deprecate my-thing@1.x "1.x is no longer supported"
26
27 In this case, a version my-thing@1.0.0-beta.0 will also be deprecated.
28
29 You must be the package owner to deprecate something. See the owner and
30 adduser help topics.
31
32 To un-deprecate a package, specify an empty string ("") for the message
33 argument. Note that you must use double quotes with no space between
34 them to format an empty string.
35
36 Configuration
37 registry
38 • Default: "https://registry.npmjs.org/"
39
40 • Type: URL
41
42
43 The base URL of the npm registry.
44
45 otp
46 • Default: null
47
48 • Type: null or String
49
50
51 This is a one-time password from a two-factor authenticator. It's
52 needed when publishing or changing package permissions with npm access.
53
54 If not set, and a registry response fails with a challenge for a one-
55 time password, npm will prompt on the command line for one.
56
57 See Also
58 • npm help "package spec"
59
60 • npm help publish
61
62 • npm help registry
63
64 • npm help owner
65
66 • npm help adduser
67
68
69
70 November 2023 NPM-DEPRECATE(1)