summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/npm-team.1
blob: 15f5ce62a7b2f5bb33af2407ace388f361296eae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.TH "NPM\-TEAM" "1" "November 2018" "" ""
.SH "NAME"
\fBnpm-team\fR \- Manage organization teams and team memberships
.SH SYNOPSIS
.P
.RS 2
.nf
npm team create <scope:team>
npm team destroy <scope:team>

npm team add <scope:team> <user>
npm team rm <scope:team> <user>

npm team ls <scope>|<scope:team>

npm team edit <scope:team>
.fi
.RE
.SH DESCRIPTION
.P
Used to manage teams in organizations, and change team memberships\. Does not
handle permissions for packages\.
.P
Teams must always be fully qualified with the organization/scope they belong to
when operating on them, separated by a colon (\fB:\fP)\. That is, if you have a
\fBdevelopers\fP team on a \fBfoo\fP organization, you must always refer to that team as
\fBfoo:developers\fP in these commands\.
.RS 0
.IP \(bu 2
create / destroy:
Create a new team, or destroy an existing one\.
.IP \(bu 2
add / rm:
Add a user to an existing team, or remove a user from a team they belong to\.
.IP \(bu 2
ls:
If performed on an organization name, will return a list of existing teams
under that organization\. If performed on a team, it will instead return a list
of all users belonging to that particular team\.
.IP \(bu 2
edit:
Edit a current team\.

.RE
.SH DETAILS
.P
\fBnpm team\fP always operates directly on the current registry, configurable from
the command line using \fB\-\-registry=<registry url>\fP\|\.
.P
In order to create teams and manage team membership, you must be a \fIteam admin\fR
under the given organization\. Listing teams and team memberships may be done by
any member of the organizations\.
.P
Organization creation and management of team admins and \fIorganization\fR members
is done through the website, not the npm CLI\.
.P
To use teams to manage permissions on packages belonging to your organization,
use the \fBnpm access\fP command to grant or revoke the appropriate permissions\.
.SH SEE ALSO
.RS 0
.IP \(bu 2
npm help access
.IP \(bu 2
npm help 7 registry

.RE