npm-org.1 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. .TH "NPM\-ORG" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-org\fR \- Manage orgs
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm org set <orgname> <username> [developer | admin | owner]
  9. npm org rm <orgname> <username>
  10. npm org ls <orgname> [<username>]
  11. .fi
  12. .RE
  13. .P
  14. Note: This command is unaware of workspaces\.
  15. .SS Example
  16. .P
  17. Add a new developer to an org:
  18. .P
  19. .RS 2
  20. .nf
  21. $ npm org set my\-org @mx\-smith
  22. .fi
  23. .RE
  24. .P
  25. Add a new admin to an org (or change a developer to an admin):
  26. .P
  27. .RS 2
  28. .nf
  29. $ npm org set my\-org @mx\-santos admin
  30. .fi
  31. .RE
  32. .P
  33. Remove a user from an org:
  34. .P
  35. .RS 2
  36. .nf
  37. $ npm org rm my\-org mx\-santos
  38. .fi
  39. .RE
  40. .P
  41. List all users in an org:
  42. .P
  43. .RS 2
  44. .nf
  45. $ npm org ls my\-org
  46. .fi
  47. .RE
  48. .P
  49. List all users in JSON format:
  50. .P
  51. .RS 2
  52. .nf
  53. $ npm org ls my\-org \-\-json
  54. .fi
  55. .RE
  56. .P
  57. See what role a user has in an org:
  58. .P
  59. .RS 2
  60. .nf
  61. $ npm org ls my\-org @mx\-santos
  62. .fi
  63. .RE
  64. .SS Description
  65. .P
  66. You can use the \fBnpm org\fP commands to manage and view users of an
  67. organization\. It supports adding and removing users, changing their roles,
  68. listing them, and finding specific ones and their roles\.
  69. .SS Configuration
  70. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  71. <!\-\- automatically generated, do not edit manually \-\->
  72. <!\-\- see lib/utils/config/definitions\.js \-\->
  73. .SS \fBregistry\fP
  74. .RS 0
  75. .IP \(bu 2
  76. Default: "https://registry\.npmjs\.org/"
  77. .IP \(bu 2
  78. Type: URL
  79. .RE
  80. .P
  81. The base URL of the npm registry\.
  82. <!\-\- automatically generated, do not edit manually \-\->
  83. <!\-\- see lib/utils/config/definitions\.js \-\->
  84. .SS \fBotp\fP
  85. .RS 0
  86. .IP \(bu 2
  87. Default: null
  88. .IP \(bu 2
  89. Type: null or String
  90. .RE
  91. .P
  92. This is a one\-time password from a two\-factor authenticator\. It's needed
  93. when publishing or changing package permissions with \fBnpm access\fP\|\.
  94. .P
  95. If not set, and a registry response fails with a challenge for a one\-time
  96. password, npm will prompt on the command line for one\.
  97. <!\-\- automatically generated, do not edit manually \-\->
  98. <!\-\- see lib/utils/config/definitions\.js \-\->
  99. .SS \fBjson\fP
  100. .RS 0
  101. .IP \(bu 2
  102. Default: false
  103. .IP \(bu 2
  104. Type: Boolean
  105. .RE
  106. .P
  107. Whether or not to output JSON data, rather than the normal output\.
  108. .RS 0
  109. .IP \(bu 2
  110. In \fBnpm pkg set\fP it enables parsing set values with JSON\.parse() before
  111. saving them to your \fBpackage\.json\fP\|\.
  112. .RE
  113. .P
  114. Not supported by all npm commands\.
  115. <!\-\- automatically generated, do not edit manually \-\->
  116. <!\-\- see lib/utils/config/definitions\.js \-\->
  117. .SS \fBparseable\fP
  118. .RS 0
  119. .IP \(bu 2
  120. Default: false
  121. .IP \(bu 2
  122. Type: Boolean
  123. .RE
  124. .P
  125. Output parseable results from commands that write to standard output\. For
  126. \fBnpm search\fP, this will be tab\-separated table format\.
  127. <!\-\- automatically generated, do not edit manually \-\->
  128. <!\-\- see lib/utils/config/definitions\.js \-\->
  129. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  130. .SS See Also
  131. .RS 0
  132. .IP \(bu 2
  133. npm help using orgs
  134. .IP \(bu 2
  135. Documentation on npm Orgs \fIhttps://docs\.npmjs\.com/orgs/\fR
  136. .RE