123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- .TH "NPM\-TEAM" "1" "August 2021" "" ""
- .SH "NAME"
- \fBnpm-team\fR \- Manage organization teams and team memberships
- .SS 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
- .SS 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 \fBwombats\fP team in a \fBwisdom\fP organization, you must always refer to that team as \fBwisdom:wombats\fP in these commands\.
- .P
- If you have two\-factor authentication enabled in \fBauth\-and\-writes\fP mode, then you can provide a code from your authenticator with \fB[\-\-otp <otpcode>]\fP\|\. If you don't include this then you will be prompted\.
- .RS 0
- .IP \(bu 2
- create / destroy:
- Create a new team, or destroy an existing one\. Note: You cannot remove the \fBdevelopers\fP team, <a href="https://docs\.npmjs\.com/about\-developers\-team" target="_blank">learn more\.</a>
- .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
- .SS 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\.
- .SS See Also
- .RS 0
- .IP \(bu 2
- npm help access
- .IP \(bu 2
- npm help registry
- .RE
|