aboutsummaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/doc/cli/npm-uninstall.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/node/deps/npm/doc/cli/npm-uninstall.md')
-rw-r--r--deps/node/deps/npm/doc/cli/npm-uninstall.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/deps/node/deps/npm/doc/cli/npm-uninstall.md b/deps/node/deps/npm/doc/cli/npm-uninstall.md
new file mode 100644
index 00000000..38302b20
--- /dev/null
+++ b/deps/node/deps/npm/doc/cli/npm-uninstall.md
@@ -0,0 +1,53 @@
+npm-uninstall(1) -- Remove a package
+=============================
+
+## SYNOPSIS
+
+ npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|--save-optional|--no-save]
+
+ aliases: remove, rm, r, un, unlink
+
+## DESCRIPTION
+
+This uninstalls a package, completely removing everything npm installed
+on its behalf.
+
+Example:
+
+ npm uninstall sax
+
+In global mode (ie, with `-g` or `--global` appended to the command),
+it uninstalls the current package context as a global package.
+
+`npm uninstall` takes 3 exclusive, optional flags which save or update
+the package version in your main package.json:
+
+* `-S, --save`: Package will be removed from your `dependencies`.
+
+* `-D, --save-dev`: Package will be removed from your `devDependencies`.
+
+* `-O, --save-optional`: Package will be removed from your `optionalDependencies`.
+
+* `--no-save`: Package will not be removed from your `package.json` file.
+
+Further, if you have an `npm-shrinkwrap.json` then it will be updated as
+well.
+
+Scope is optional and follows the usual rules for `npm-scope(7)`.
+
+Examples:
+
+ npm uninstall sax --save
+ npm uninstall @myorg/privatepackage --save
+ npm uninstall node-tap --save-dev
+ npm uninstall dtrace-provider --save-optional
+ npm uninstall lodash --no-save
+
+## SEE ALSO
+
+* npm-prune(1)
+* npm-install(1)
+* npm-folders(5)
+* npm-config(1)
+* npm-config(7)
+* npmrc(5)