npm-team.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. <html><head>
  2. <title>npm-team</title>
  3. <style>
  4. body {
  5. background-color: #ffffff;
  6. color: #24292e;
  7. margin: 0;
  8. line-height: 1.5;
  9. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  10. }
  11. #rainbar {
  12. height: 10px;
  13. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  14. }
  15. a {
  16. text-decoration: none;
  17. color: #0366d6;
  18. }
  19. a:hover {
  20. text-decoration: underline;
  21. }
  22. pre {
  23. margin: 1em 0px;
  24. padding: 1em;
  25. border: solid 1px #e1e4e8;
  26. border-radius: 6px;
  27. display: block;
  28. overflow: auto;
  29. white-space: pre;
  30. background-color: #f6f8fa;
  31. color: #393a34;
  32. }
  33. code {
  34. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  35. font-size: 85%;
  36. padding: 0.2em 0.4em;
  37. background-color: #f6f8fa;
  38. color: #393a34;
  39. }
  40. pre > code {
  41. padding: 0;
  42. background-color: inherit;
  43. color: inherit;
  44. }
  45. h1, h2, h3 {
  46. font-weight: 600;
  47. }
  48. #logobar {
  49. background-color: #333333;
  50. margin: 0 auto;
  51. padding: 1em 4em;
  52. }
  53. #logobar .logo {
  54. float: left;
  55. }
  56. #logobar .title {
  57. font-weight: 600;
  58. color: #dddddd;
  59. float: left;
  60. margin: 5px 0 0 1em;
  61. }
  62. #logobar:after {
  63. content: "";
  64. display: block;
  65. clear: both;
  66. }
  67. #content {
  68. margin: 0 auto;
  69. padding: 0 4em;
  70. }
  71. #table_of_contents > h2 {
  72. font-size: 1.17em;
  73. }
  74. #table_of_contents ul:first-child {
  75. border: solid 1px #e1e4e8;
  76. border-radius: 6px;
  77. padding: 1em;
  78. background-color: #f6f8fa;
  79. color: #393a34;
  80. }
  81. #table_of_contents ul {
  82. list-style-type: none;
  83. padding-left: 1.5em;
  84. }
  85. #table_of_contents li {
  86. font-size: 0.9em;
  87. }
  88. #table_of_contents li a {
  89. color: #000000;
  90. }
  91. header.title {
  92. border-bottom: solid 1px #e1e4e8;
  93. }
  94. header.title > h1 {
  95. margin-bottom: 0.25em;
  96. }
  97. header.title > .description {
  98. display: block;
  99. margin-bottom: 0.5em;
  100. line-height: 1;
  101. }
  102. footer#edit {
  103. border-top: solid 1px #e1e4e8;
  104. margin: 3em 0 4em 0;
  105. padding-top: 2em;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div id="banner">
  111. <div id="rainbar"></div>
  112. <div id="logobar">
  113. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  114. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  115. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  116. </svg>
  117. <div class="title">
  118. npm command-line interface
  119. </div>
  120. </div>
  121. </div>
  122. <section id="content">
  123. <header class="title">
  124. <h1 id="npm-team">npm-team</h1>
  125. <span class="description">Manage organization teams and team memberships</span>
  126. </header>
  127. <section id="table_of_contents">
  128. <h2 id="table-of-contents">Table of contents</h2>
  129. <div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#details">Details</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#registry"><code>registry</code></a></li><li><a href="#otp"><code>otp</code></a></li><li><a href="#parseable"><code>parseable</code></a></li><li><a href="#json"><code>json</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
  130. </section>
  131. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  132. <pre lang="bash"><code>npm team create &lt;scope:team&gt;
  133. npm team destroy &lt;scope:team&gt;
  134. npm team add &lt;scope:team&gt; &lt;user&gt;
  135. npm team rm &lt;scope:team&gt; &lt;user&gt;
  136. npm team ls &lt;scope&gt;|&lt;scope:team&gt;
  137. </code></pre>
  138. <p>Note: This command is unaware of workspaces.</p>
  139. <h3 id="description">Description</h3>
  140. <p>Used to manage teams in organizations, and change team memberships. Does not
  141. handle permissions for packages.</p>
  142. <p>Teams must always be fully qualified with the organization/scope they belong to
  143. when operating on them, separated by a colon (<code>:</code>). That is, if you have a
  144. <code>newteam</code> team in an <code>org</code> organization, you must always refer to that team
  145. as <code>@org:newteam</code> in these commands.</p>
  146. <p>If you have two-factor authentication enabled in <code>auth-and-writes</code> mode, then
  147. you can provide a code from your authenticator with <code>[--otp &lt;otpcode&gt;]</code>.
  148. If you don’t include this then you will be prompted.</p>
  149. <ul>
  150. <li>
  151. <p>create / destroy:
  152. Create a new team, or destroy an existing one. Note: You cannot remove the
  153. <code>developers</code> team, <!-- raw HTML omitted -->learn more.<!-- raw HTML omitted --></p>
  154. <p>Here’s how to create a new team <code>newteam</code> under the <code>org</code> org:</p>
  155. <pre lang="bash"><code>npm team create @org:newteam
  156. </code></pre>
  157. <p>You should see a confirming message such as: <code>+@org:newteam</code> once the new
  158. team has been created.</p>
  159. </li>
  160. <li>
  161. <p>add:
  162. Add a user to an existing team.</p>
  163. <p>Adding a new user <code>username</code> to a team named <code>newteam</code> under the <code>org</code> org:</p>
  164. <pre lang="bash"><code>npm team add @org:newteam username
  165. </code></pre>
  166. <p>On success, you should see a message: <code>username added to @org:newteam</code></p>
  167. </li>
  168. <li>
  169. <p>rm:
  170. Using <code>npm team rm</code> you can also remove users from a team they belong to.</p>
  171. <p>Here’s an example removing user <code>username</code> from <code>newteam</code> team
  172. in <code>org</code> organization:</p>
  173. <pre lang="bash"><code>npm team rm @org:newteam username
  174. </code></pre>
  175. <p>Once the user is removed a confirmation message is displayed:
  176. <code>username removed from @org:newteam</code></p>
  177. </li>
  178. <li>
  179. <p>ls:
  180. If performed on an organization name, will return a list of existing teams
  181. under that organization. If performed on a team, it will instead return a list
  182. of all users belonging to that particular team.</p>
  183. <p>Here’s an example of how to list all teams from an org named <code>org</code>:</p>
  184. <pre lang="bash"><code>npm team ls @org
  185. </code></pre>
  186. <p>Example listing all members of a team named <code>newteam</code>:</p>
  187. <pre lang="bash"><code>npm team ls @org:newteam
  188. </code></pre>
  189. </li>
  190. </ul>
  191. <h3 id="details">Details</h3>
  192. <p><code>npm team</code> always operates directly on the current registry, configurable from
  193. the command line using <code>--registry=&lt;registry url&gt;</code>.</p>
  194. <p>You must be a <em>team admin</em> to create teams and manage team membership, under
  195. the given organization. Listing teams and team memberships may be done by
  196. any member of the organization.</p>
  197. <p>Organization creation and management of team admins and <em>organization</em> members
  198. is done through the website, not the npm CLI.</p>
  199. <p>To use teams to manage permissions on packages belonging to your organization,
  200. use the <code>npm access</code> command to grant or revoke the appropriate permissions.</p>
  201. <h3 id="configuration">Configuration</h3>
  202. <!-- raw HTML omitted -->
  203. <!-- raw HTML omitted -->
  204. <!-- raw HTML omitted -->
  205. <h4 id="registry"><code>registry</code></h4>
  206. <ul>
  207. <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li>
  208. <li>Type: URL</li>
  209. </ul>
  210. <p>The base URL of the npm registry.</p>
  211. <!-- raw HTML omitted -->
  212. <!-- raw HTML omitted -->
  213. <h4 id="otp"><code>otp</code></h4>
  214. <ul>
  215. <li>Default: null</li>
  216. <li>Type: null or String</li>
  217. </ul>
  218. <p>This is a one-time password from a two-factor authenticator. It’s needed
  219. when publishing or changing package permissions with <code>npm access</code>.</p>
  220. <p>If not set, and a registry response fails with a challenge for a one-time
  221. password, npm will prompt on the command line for one.</p>
  222. <!-- raw HTML omitted -->
  223. <!-- raw HTML omitted -->
  224. <h4 id="parseable"><code>parseable</code></h4>
  225. <ul>
  226. <li>Default: false</li>
  227. <li>Type: Boolean</li>
  228. </ul>
  229. <p>Output parseable results from commands that write to standard output. For
  230. <code>npm search</code>, this will be tab-separated table format.</p>
  231. <!-- raw HTML omitted -->
  232. <!-- raw HTML omitted -->
  233. <h4 id="json"><code>json</code></h4>
  234. <ul>
  235. <li>Default: false</li>
  236. <li>Type: Boolean</li>
  237. </ul>
  238. <p>Whether or not to output JSON data, rather than the normal output.</p>
  239. <ul>
  240. <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
  241. saving them to your <code>package.json</code>.</li>
  242. </ul>
  243. <p>Not supported by all npm commands.</p>
  244. <!-- raw HTML omitted -->
  245. <!-- raw HTML omitted -->
  246. <!-- raw HTML omitted -->
  247. <h3 id="see-also">See Also</h3>
  248. <ul>
  249. <li><a href="../commands/npm-access.html">npm access</a></li>
  250. <li><a href="../commands/npm-config.html">npm config</a></li>
  251. <li><a href="../using-npm/registry.html">npm registry</a></li>
  252. </ul>
  253. </div>
  254. <footer id="edit">
  255. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-team.md">
  256. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  257. <path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
  258. </svg>
  259. Edit this page on GitHub
  260. </a>
  261. </footer>
  262. </section>
  263. </body></html>