nodejs/deps/npm/man/man1/npm-explore.1

50 lines
1.1 KiB
Groff
Raw Permalink Normal View History

.TH "NPM-EXPLORE" "1" "April 2025" "NPM@11.3.0" ""
.SH "NAME"
\fBnpm-explore\fR - Browse an installed package
.SS "Synopsis"
2014-09-24 14:41:07 -07:00
.P
.RS 2
2014-11-04 15:08:12 -08:00
.nf
npm explore <pkg> \[lB] -- <command>\[rB]
2014-11-04 15:08:12 -08:00
.fi
2014-09-24 14:41:07 -07:00
.RE
.P
Note: This command is unaware of workspaces.
.SS "Description"
2014-09-24 14:41:07 -07:00
.P
Spawn a subshell in the directory of the installed package specified.
.P
If a command is specified, then it is run in the subshell, which then immediately terminates.
.P
This is particularly handy in the case of git submodules in the \fBnode_modules\fR folder:
2014-09-24 14:41:07 -07:00
.P
.RS 2
2014-11-04 15:08:12 -08:00
.nf
npm explore some-dependency -- git pull origin master
2014-11-04 15:08:12 -08:00
.fi
2014-09-24 14:41:07 -07:00
.RE
.P
Note that the package is \fInot\fR automatically rebuilt afterwards, so be sure to use \fBnpm rebuild <pkg>\fR if you make any changes.
.SS "Configuration"
.SS "\fBshell\fR"
2014-09-24 14:41:07 -07:00
.RS 0
.IP \(bu 4
Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on Windows
.IP \(bu 4
Type: String
.RE 0
2014-09-24 14:41:07 -07:00
.P
The shell to run for the \fBnpm explore\fR command.
.SS "See Also"
2014-09-24 14:41:07 -07:00
.RS 0
.IP \(bu 4
npm help folders
.IP \(bu 4
npm help edit
.IP \(bu 4
npm help rebuild
.IP \(bu 4
npm help install
.RE 0