summaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli/npm-deprecate.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/cli/npm-deprecate.md')
-rw-r--r--deps/npm/doc/cli/npm-deprecate.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/deps/npm/doc/cli/npm-deprecate.md b/deps/npm/doc/cli/npm-deprecate.md
new file mode 100644
index 000000000..e62579349
--- /dev/null
+++ b/deps/npm/doc/cli/npm-deprecate.md
@@ -0,0 +1,26 @@
+npm-deprecate(1) -- Deprecate a version of a package
+====================================================
+
+## SYNOPSIS
+
+ npm deprecate <name>[@<version>] <message>
+
+## 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 as well as specific versions, so you can do
+something like this:
+
+ npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
+
+Note that you must be the package owner to deprecate something. See the
+`owner` and `adduser` help topics.
+
+To un-deprecate a package, specify an empty string (`""`) for the `message` argument.
+
+## SEE ALSO
+
+* npm-publish(1)
+* npm-registry(7)