npm-repo.1 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. .TH "NPM\-REPO" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-repo\fR \- Open package repository page in the browser
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm repo [<pkgname> [<pkgname> \.\.\.]]
  9. .fi
  10. .RE
  11. .SS Description
  12. .P
  13. This command tries to guess at the likely location of a package's
  14. repository URL, and then tries to open it using the \fB\-\-browser\fP config
  15. param\. If no package name is provided, it will search for a \fBpackage\.json\fP
  16. in the current folder and use the \fBrepository\fP property\.
  17. .SS Configuration
  18. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  19. <!\-\- automatically generated, do not edit manually \-\->
  20. <!\-\- see lib/utils/config/definitions\.js \-\->
  21. .SS \fBbrowser\fP
  22. .RS 0
  23. .IP \(bu 2
  24. Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP
  25. .IP \(bu 2
  26. Type: null, Boolean, or String
  27. .RE
  28. .P
  29. The browser that is called by npm commands to open websites\.
  30. .P
  31. Set to \fBfalse\fP to suppress browser behavior and instead print urls to
  32. terminal\.
  33. .P
  34. Set to \fBtrue\fP to use default system URL opener\.
  35. <!\-\- automatically generated, do not edit manually \-\->
  36. <!\-\- see lib/utils/config/definitions\.js \-\->
  37. .SS \fBworkspace\fP
  38. .RS 0
  39. .IP \(bu 2
  40. Default:
  41. .IP \(bu 2
  42. Type: String (can be set multiple times)
  43. .RE
  44. .P
  45. Enable running a command in the context of the configured workspaces of the
  46. current project while filtering by running only the workspaces defined by
  47. this configuration option\.
  48. .P
  49. Valid values for the \fBworkspace\fP config are either:
  50. .RS 0
  51. .IP \(bu 2
  52. Workspace names
  53. .IP \(bu 2
  54. Path to a workspace directory
  55. .IP \(bu 2
  56. Path to a parent workspace directory (will result in selecting all
  57. workspaces within that folder)
  58. .RE
  59. .P
  60. When set for the \fBnpm init\fP command, this may be set to the folder of a
  61. workspace which does not yet exist, to create the folder and set it up as a
  62. brand new workspace within the project\.
  63. .P
  64. This value is not exported to the environment for child processes\.
  65. <!\-\- automatically generated, do not edit manually \-\->
  66. <!\-\- see lib/utils/config/definitions\.js \-\->
  67. .SS \fBworkspaces\fP
  68. .RS 0
  69. .IP \(bu 2
  70. Default: null
  71. .IP \(bu 2
  72. Type: null or Boolean
  73. .RE
  74. .P
  75. Set to true to run the command in the context of \fBall\fR configured
  76. workspaces\.
  77. .P
  78. Explicitly setting this to false will cause commands like \fBinstall\fP to
  79. ignore workspaces altogether\. When not set explicitly:
  80. .RS 0
  81. .IP \(bu 2
  82. Commands that operate on the \fBnode_modules\fP tree (install, update, etc\.)
  83. will link workspaces into the \fBnode_modules\fP folder\. \- Commands that do
  84. other things (test, exec, publish, etc\.) will operate on the root project,
  85. \fIunless\fR one or more workspaces are specified in the \fBworkspace\fP config\.
  86. .RE
  87. .P
  88. This value is not exported to the environment for child processes\.
  89. <!\-\- automatically generated, do not edit manually \-\->
  90. <!\-\- see lib/utils/config/definitions\.js \-\->
  91. .SS \fBinclude\-workspace\-root\fP
  92. .RS 0
  93. .IP \(bu 2
  94. Default: false
  95. .IP \(bu 2
  96. Type: Boolean
  97. .RE
  98. .P
  99. Include the workspace root when workspaces are enabled for a command\.
  100. .P
  101. When false, specifying individual workspaces via the \fBworkspace\fP config, or
  102. all workspaces via the \fBworkspaces\fP flag, will cause npm to operate only on
  103. the specified workspaces, and not on the root project\.
  104. <!\-\- automatically generated, do not edit manually \-\->
  105. <!\-\- see lib/utils/config/definitions\.js \-\->
  106. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  107. .SS See Also
  108. .RS 0
  109. .IP \(bu 2
  110. npm help docs
  111. .IP \(bu 2
  112. npm help config
  113. .RE