npm-explore.1 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .TH "NPM\-EXPLORE" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-explore\fR \- Browse an installed package
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm explore <pkg> [ \-\- <command>]
  9. .fi
  10. .RE
  11. .P
  12. Note: This command is unaware of workspaces\.
  13. .SS Description
  14. .P
  15. Spawn a subshell in the directory of the installed package specified\.
  16. .P
  17. If a command is specified, then it is run in the subshell, which then
  18. immediately terminates\.
  19. .P
  20. This is particularly handy in the case of git submodules in the
  21. \fBnode_modules\fP folder:
  22. .P
  23. .RS 2
  24. .nf
  25. npm explore some\-dependency \-\- git pull origin master
  26. .fi
  27. .RE
  28. .P
  29. Note that the package is \fInot\fR automatically rebuilt afterwards, so be
  30. sure to use \fBnpm rebuild <pkg>\fP if you make any changes\.
  31. .SS Configuration
  32. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  33. <!\-\- automatically generated, do not edit manually \-\->
  34. <!\-\- see lib/utils/config/definitions\.js \-\->
  35. .SS \fBshell\fP
  36. .RS 0
  37. .IP \(bu 2
  38. Default: SHELL environment variable, or "bash" on Posix, or "cmd\.exe" on
  39. Windows
  40. .IP \(bu 2
  41. Type: String
  42. .RE
  43. .P
  44. The shell to run for the \fBnpm explore\fP command\.
  45. <!\-\- automatically generated, do not edit manually \-\->
  46. <!\-\- see lib/utils/config/definitions\.js \-\->
  47. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  48. .SS See Also
  49. .RS 0
  50. .IP \(bu 2
  51. npm help folders
  52. .IP \(bu 2
  53. npm help edit
  54. .IP \(bu 2
  55. npm help rebuild
  56. .IP \(bu 2
  57. npm help install
  58. .RE