summaryrefslogtreecommitdiff
path: root/deps/npm/man/man7/npm-orgs.7
blob: c01f4e6ab7a107a6f9e8ccbf406be283b63d58cb (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.TH "NPM\-ORGS" "7" "August 2019" "" ""
.SH "NAME"
\fBnpm-orgs\fR \- Working with Teams & Orgs
.SH DESCRIPTION
.P
There are three levels of org users:
.RS 0
.IP 1. 3
Super admin, controls billing & adding people to the org\.
.IP 2. 3
Team admin, manages team membership & package access\.
.IP 3. 3
Developer, works on packages they are given access to\.  

.RE
.P
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\.
.P
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\.
.P
The developer will be able to access packages based on the teams they are on\. Access is either read\-write or read\-only\.
.P
There are two main commands:
.RS 0
.IP 1. 3
\fBnpm team\fP see npm help team for more details
.IP 2. 3
\fBnpm access\fP see npm help access for more details

.RE
.SH Team Admins create teams
.RS 0
.IP \(bu 2
Check who you’ve added to your org:

.RE
.P
.RS 2
.nf
npm team ls <org>:developers
.fi
.RE
.RS 0
.IP \(bu 2
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\.
.IP \(bu 2
Create a new team:

.RE
.P
.RS 2
.nf
npm team create <org:team>
.fi
.RE
.RS 0
.IP \(bu 2
Add members to that team:

.RE
.P
.RS 2
.nf
npm team add <org:team> <user>
.fi
.RE
.SH Publish a package and adjust package access
.RS 0
.IP \(bu 2
In package directory, run

.RE
.P
.RS 2
.nf
npm init \-\-scope=<org>
.fi
.RE
.P
to scope it for your org & publish as usual
.RS 0
.IP \(bu 2
Grant access:  

.RE
.P
.RS 2
.nf
npm access grant <read\-only|read\-write> <org:team> [<package>]
.fi
.RE
.RS 0
.IP \(bu 2
Revoke access:

.RE
.P
.RS 2
.nf
npm access revoke <org:team> [<package>]
.fi
.RE
.SH Monitor your package access
.RS 0
.IP \(bu 2
See what org packages a team member can access:

.RE
.P
.RS 2
.nf
npm access ls\-packages <org> <user>
.fi
.RE
.RS 0
.IP \(bu 2
See packages available to a specific team:

.RE
.P
.RS 2
.nf
npm access ls\-packages <org:team>
.fi
.RE
.RS 0
.IP \(bu 2
Check which teams are collaborating on a package:

.RE
.P
.RS 2
.nf
npm access ls\-collaborators <pkg>
.fi
.RE
.SH SEE ALSO
.RS 0
.IP \(bu 2
npm help team
.IP \(bu 2
npm help access
.IP \(bu 2
npm help 7 scope

.RE