summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/npm-explore.1
blob: 39fe060038a8496d7deec03f0eb2fca706e91f6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.TH "NPM-EXPLORE" "1" "May 2023" "" ""
.SH "NAME"
\fBnpm-explore\fR - Browse an installed package
.SS "Synopsis"
.P
.RS 2
.nf
npm explore <pkg> \[lB] -- <command>\[rB]
.fi
.RE
.P
Note: This command is unaware of workspaces.
.SS "Description"
.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:
.P
.RS 2
.nf
npm explore some-dependency -- git pull origin master
.fi
.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"
.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

.P
The shell to run for the \fBnpm explore\fR command.
.SS "See Also"
.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