diff options
Diffstat (limited to 'deps/npm/doc/api/explore.md')
| -rw-r--r-- | deps/npm/doc/api/explore.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/deps/npm/doc/api/explore.md b/deps/npm/doc/api/explore.md new file mode 100644 index 0000000000..a239f3df31 --- /dev/null +++ b/deps/npm/doc/api/explore.md @@ -0,0 +1,18 @@ +npm-explore(3) -- Browse an installed package +============================================= + +## SYNOPSIS + + npm.commands.explore(args, callback) + +## 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. + +Note that the package is *not* automatically rebuilt afterwards, so be +sure to use `npm rebuild <pkg>` if you make any changes. + +The first element in the 'args' parameter must be a package name. After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command. |