npm-ls.1 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. .TH "NPM\-LS" "1" "August 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-ls\fR \- List installed packages
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm ls [[<@scope>/]<pkg> \.\.\.]
  9. aliases: list, la, ll
  10. .fi
  11. .RE
  12. .SS Description
  13. .P
  14. This command will print to stdout all the versions of packages that are
  15. installed, as well as their dependencies, in a tree\-structure\.
  16. .P
  17. Positional arguments are \fBname@version\-range\fP identifiers, which will
  18. limit the results to only the paths to the packages named\. Note that
  19. nested packages will \fIalso\fR show the paths to the specified packages\.
  20. For example, running \fBnpm ls promzard\fP in npm's source tree will show:
  21. .P
  22. .RS 2
  23. .nf
  24. npm@6\.14\.15 /path/to/npm
  25. └─┬ init\-package\-json@0\.0\.4
  26. └── promzard@0\.1\.5
  27. .fi
  28. .RE
  29. .P
  30. It will print out extraneous, missing, and invalid packages\.
  31. .P
  32. If a project specifies git urls for dependencies these are shown
  33. in parentheses after the name@version to make it easier for users to
  34. recognize potential forks of a project\.
  35. .P
  36. The tree shown is the logical dependency tree, based on package
  37. dependencies, not the physical layout of your node_modules folder\.
  38. .P
  39. When run as \fBll\fP or \fBla\fP, it shows extended information by default\.
  40. .SS Configuration
  41. .SS json
  42. .RS 0
  43. .IP \(bu 2
  44. Default: false
  45. .IP \(bu 2
  46. Type: Boolean
  47. .RE
  48. .P
  49. Show information in JSON format\.
  50. .SS long
  51. .RS 0
  52. .IP \(bu 2
  53. Default: false
  54. .IP \(bu 2
  55. Type: Boolean
  56. .RE
  57. .P
  58. Show extended information\.
  59. .SS parseable
  60. .RS 0
  61. .IP \(bu 2
  62. Default: false
  63. .IP \(bu 2
  64. Type: Boolean
  65. .RE
  66. .P
  67. Show parseable output instead of tree view\.
  68. .SS global
  69. .RS 0
  70. .IP \(bu 2
  71. Default: false
  72. .IP \(bu 2
  73. Type: Boolean
  74. .RE
  75. .P
  76. List packages in the global install prefix instead of in the current
  77. project\.
  78. .SS depth
  79. .RS 0
  80. .IP \(bu 2
  81. Type: Int
  82. .RE
  83. .P
  84. Max display depth of the dependency tree\.
  85. .SS prod / production
  86. .RS 0
  87. .IP \(bu 2
  88. Type: Boolean
  89. .IP \(bu 2
  90. Default: false
  91. .RE
  92. .P
  93. Display only the dependency tree for packages in \fBdependencies\fP\|\.
  94. .SS dev / development
  95. .RS 0
  96. .IP \(bu 2
  97. Type: Boolean
  98. .IP \(bu 2
  99. Default: false
  100. .RE
  101. .P
  102. Display only the dependency tree for packages in \fBdevDependencies\fP\|\.
  103. .SS only
  104. .RS 0
  105. .IP \(bu 2
  106. Type: String
  107. .RE
  108. .P
  109. When "dev" or "development", is an alias to \fBdev\fP\|\.
  110. .P
  111. When "prod" or "production", is an alias to \fBproduction\fP\|\.
  112. .SS link
  113. .RS 0
  114. .IP \(bu 2
  115. Type: Boolean
  116. .IP \(bu 2
  117. Default: false
  118. .RE
  119. .P
  120. Display only dependencies which are linked
  121. .SS unicode
  122. .RS 0
  123. .IP \(bu 2
  124. Type: Boolean
  125. .IP \(bu 2
  126. Default: true
  127. .RE
  128. .P
  129. Whether to represent the tree structure using unicode characters\.
  130. Set it to false in order to use all\-ansi output\.
  131. .SS See Also
  132. .RS 0
  133. .IP \(bu 2
  134. npm help config
  135. .IP \(bu 2
  136. npm help npmrc
  137. .IP \(bu 2
  138. npm help folders
  139. .IP \(bu 2
  140. npm help install
  141. .IP \(bu 2
  142. npm help link
  143. .IP \(bu 2
  144. npm help prune
  145. .IP \(bu 2
  146. npm help outdated
  147. .IP \(bu 2
  148. npm help update
  149. .RE