Update uninstall documentation to include flags

This update adds the notes to use --save, --save-dev, -g, and
--save-optional to the uninstall docs.
This commit is contained in:
Shawn Wildermuth
2014-02-17 17:16:45 -05:00
committed by Domenic Denicola
parent 3e6e99409e
commit e95b5aa0f3

View File

@@ -3,14 +3,36 @@ npm-rm(1) -- Remove a package
## SYNOPSIS
npm rm <name>
npm uninstall <name>
npm uninstall <name> [--save|--save-dev|--save-optional]
npm rm (with any of the previous argument usage)
## 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:
* `--save`: Package will be removed from your `dependencies`.
* `--save-dev`: Package will be removed from your `devDependencies`.
* `--save-optional`: Package will be removed from your `optionalDependencies`.
Examples:
npm uninstall sax --save
npm uninstall node-tap --save-dev
npm uninstall dtrace-provider --save-optional
## SEE ALSO
* npm-prune(1)