npm-explore.1 1.1 KB

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