diff options
Diffstat (limited to 'docs/content/commands/npm-explore.md')
-rw-r--r-- | docs/content/commands/npm-explore.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/content/commands/npm-explore.md b/docs/content/commands/npm-explore.md new file mode 100644 index 000000000..2466407b7 --- /dev/null +++ b/docs/content/commands/npm-explore.md @@ -0,0 +1,46 @@ +--- +title: npm-explore +section: 1 +description: Browse an installed package +--- + +### Synopsis + +```bash +npm explore <pkg> [ -- <command>] +``` + +### Description + +Spawn a subshell in the directory of the installed package specified. + +If a command is specified, then it is run in the subshell, which then +immediately terminates. + +This is particularly handy in the case of git submodules in the +`node_modules` folder: + +```bash +npm explore some-dependency -- git pull origin master +``` + +Note that the package is *not* automatically rebuilt afterwards, so be +sure to use `npm rebuild <pkg>` if you make any changes. + +### Configuration + +#### shell + +* Default: SHELL environment variable, or "bash" on Posix, or "cmd" on + Windows +* Type: path + +The shell to run for the `npm explore` command. + +### See Also + +* [npm folders](/configuring-npm/folders) +* [npm edit](/cli-commands/edit) +* [npm rebuild](/cli-commands/rebuild) +* [npm build](/cli-commands/build) +* [npm install](/cli-commands/install) |