orgs.7 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. .TH "ORGS" "7" "August 2021" "" ""
  2. .SH "NAME"
  3. \fBorgs\fR \- Working with Teams & Orgs
  4. .SS Description
  5. .P
  6. There are three levels of org users:
  7. .RS 0
  8. .IP 1. 3
  9. Super admin, controls billing & adding people to the org\.
  10. .IP 2. 3
  11. Team admin, manages team membership & package access\.
  12. .IP 3. 3
  13. Developer, works on packages they are given access to\.
  14. .RE
  15. .P
  16. The super admin is the only person who can add users to the org because it impacts the monthly bill\. The super admin will use the website to manage membership\. Every org has a \fBdevelopers\fP team that all users are automatically added to\.
  17. .P
  18. The team admin is the person who manages team creation, team membership, and package access for teams\. The team admin grants package access to teams, not individuals\.
  19. .P
  20. The developer will be able to access packages based on the teams they are on\. Access is either read\-write or read\-only\.
  21. .P
  22. There are two main commands:
  23. .RS 0
  24. .IP 1. 3
  25. \fBnpm team\fP see npm help team for more details
  26. .IP 2. 3
  27. \fBnpm access\fP see npm help access for more details
  28. .RE
  29. .SS Team Admins create teams
  30. .RS 0
  31. .IP \(bu 2
  32. Check who you’ve added to your org:
  33. .RE
  34. .P
  35. .RS 2
  36. .nf
  37. npm team ls <org>:developers
  38. .fi
  39. .RE
  40. .RS 0
  41. .IP \(bu 2
  42. Each org is automatically given a \fBdevelopers\fP team, so you can see the whole list of team members in your org\. This team automatically gets read\-write access to all packages, but you can change that with the \fBaccess\fP command\.
  43. .IP \(bu 2
  44. Create a new team:
  45. .RE
  46. .P
  47. .RS 2
  48. .nf
  49. npm team create <org:team>
  50. .fi
  51. .RE
  52. .RS 0
  53. .IP \(bu 2
  54. Add members to that team:
  55. .RE
  56. .P
  57. .RS 2
  58. .nf
  59. npm team add <org:team> <user>
  60. .fi
  61. .RE
  62. .SS Publish a package and adjust package access
  63. .RS 0
  64. .IP \(bu 2
  65. In package directory, run
  66. .RE
  67. .P
  68. .RS 2
  69. .nf
  70. npm init \-\-scope=<org>
  71. .fi
  72. .RE
  73. .P
  74. to scope it for your org & publish as usual
  75. .RS 0
  76. .IP \(bu 2
  77. Grant access:
  78. .RE
  79. .P
  80. .RS 2
  81. .nf
  82. npm access grant <read\-only|read\-write> <org:team> [<package>]
  83. .fi
  84. .RE
  85. .RS 0
  86. .IP \(bu 2
  87. Revoke access:
  88. .RE
  89. .P
  90. .RS 2
  91. .nf
  92. npm access revoke <org:team> [<package>]
  93. .fi
  94. .RE
  95. .SS Monitor your package access
  96. .RS 0
  97. .IP \(bu 2
  98. See what org packages a team member can access:
  99. .RE
  100. .P
  101. .RS 2
  102. .nf
  103. npm access ls\-packages <org> <user>
  104. .fi
  105. .RE
  106. .RS 0
  107. .IP \(bu 2
  108. See packages available to a specific team:
  109. .RE
  110. .P
  111. .RS 2
  112. .nf
  113. npm access ls\-packages <org:team>
  114. .fi
  115. .RE
  116. .RS 0
  117. .IP \(bu 2
  118. Check which teams are collaborating on a package:
  119. .RE
  120. .P
  121. .RS 2
  122. .nf
  123. npm access ls\-collaborators <pkg>
  124. .fi
  125. .RE
  126. .SS See also
  127. .RS 0
  128. .IP \(bu 2
  129. npm help team
  130. .IP \(bu 2
  131. npm help access
  132. .IP \(bu 2
  133. npm help scope
  134. .RE