diff options
| author | Rebecca Turner <me@re-becca.org> | 2015-06-15 23:18:20 +0300 |
|---|---|---|
| committer | Rebecca Turner <me@re-becca.org> | 2015-06-26 03:27:18 +0300 |
| commit | aa00b187241b3948501004ccc0941d7eb60d9526 (patch) | |
| tree | a66361cc7ba928dbdf4408f0be062f14d8d80cba /doc | |
| parent | 02f1ff017d06ea9f7ab99bb3585ed3cd792da5ad (diff) | |
docs: Add documentation for new --dry-run option
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-install.md | 5 | ||||
| -rw-r--r-- | doc/misc/npm-config.md | 11 |
2 files changed, 15 insertions, 1 deletions
diff --git a/doc/cli/npm-install.md b/doc/cli/npm-install.md index b382b114f..847a64ab0 100644 --- a/doc/cli/npm-install.md +++ b/doc/cli/npm-install.md @@ -13,7 +13,7 @@ npm-install(1) -- Install a package npm install <folder> alias: npm i - common options: [--save|--save-dev|--save-optional] [--save-exact] + common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run] ## DESCRIPTION @@ -246,6 +246,9 @@ The `--tag` argument will apply to all of the specified install targets. If a tag with the given name exists, the tagged version is preferred over newer versions. +The `--dry-run` argument will report in the usual way what the install would +have done without actually installing anything. + The `--force` argument will force npm to fetch remote resources even if a local copy exists on disk. diff --git a/doc/misc/npm-config.md b/doc/misc/npm-config.md index 454130d43..167aaf7d7 100644 --- a/doc/misc/npm-config.md +++ b/doc/misc/npm-config.md @@ -268,6 +268,17 @@ Install `dev-dependencies` along with packages. Note that `dev-dependencies` are also installed if the `npat` flag is set. +### dry-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`. This is NOT currently honored by network related +commands, eg `dist-tags`, `owner`, `publish`, etc. + ### editor * Default: `EDITOR` environment variable if set, or `"vi"` on Posix, |