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