summaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli/explore.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/cli/explore.md')
-rw-r--r--deps/npm/doc/cli/explore.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/deps/npm/doc/cli/explore.md b/deps/npm/doc/cli/explore.md
new file mode 100644
index 0000000000..00701b392a
--- /dev/null
+++ b/deps/npm/doc/cli/explore.md
@@ -0,0 +1,40 @@
+npm-explore(1) -- Browse an installed package
+=============================================
+
+## SYNOPSIS
+
+ npm explore <name>[@<version>] [ -- <cmd>]
+
+## 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:
+
+ 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-submodule(1)
+* npm-folders(1)
+* npm-edit(1)
+* npm-rebuild(1)
+* npm-build(1)
+* npm-install(1)