1NPM-TEAM(1)                                                        NPM-TEAM(1)
2
3
4

NAME

6       npm-team - Manage organization teams and team memberships
7
8   Synopsis
9         npm team create <scope:team>
10         npm team destroy <scope:team>
11
12         npm team add <scope:team> <user>
13         npm team rm <scope:team> <user>
14
15         npm team ls <scope>|<scope:team>
16
17       Note: This command is unaware of workspaces.
18
19   Description
20       Used  to  manage  teams  in organizations, and change team memberships.
21       Does not handle permissions for packages.
22
23       Teams must always be fully qualified with the  organization/scope  they
24       belong to when operating on them, separated by a colon (:). That is, if
25       you have a newteam team in an org organization, you must  always  refer
26       to that team as @org:newteam in these commands.
27
28       If  you have two-factor authentication enabled in auth-and-writes mode,
29       then you can provide a code from your authenticator with  [--otp  <otp‐
30       code>].  If you don't include this then you will be prompted.
31
32       • create  /  destroy:  Create  a  new team, or destroy an existing one.
33         Note:    You    cannot    remove    the    developers    team,     <a
34         href="https://docs.npmjs.com/about-developers-team"              tar‐
35         get="_blank">learn more.</a> Here's how to create a new team  newteam
36         under the org org:
37
38         npm team create @org:newteam
39       You should see a confirming message such as: +@org:newteam once the new
40       team has been created.
41
42       • add: Add a user to an existing team.  Adding a new user username to a
43         team named newteam under the org org:
44
45         npm team add @org:newteam username
46       On success, you should see a message: username added to @org:newteam
47
48       • rm:  Using npm team rm you can also remove users from a team they be‐
49         long to.  Here's an example removing user username from newteam  team
50         in org organization:
51
52         npm team rm @org:newteam username
53       Once  the user is removed a confirmation message is displayed: username
54       removed from @org:newteam
55
56       • ls: If performed on an organization name, will return a list  of  ex‐
57         isting teams under that organization. If performed on a team, it will
58         instead return a list of all users belonging to that particular team.
59         Here's an example of how to list all teams from an org named org:
60
61         npm team ls @org
62       Example listing all members of a team named newteam:
63
64         npm team ls @org:newteam
65
66
67   Details
68       npm team always operates directly on the current registry, configurable
69       from the command line using --registry=<registry url>.
70
71       You must be a team admin to create teams and  manage  team  membership,
72       under the given organization. Listing teams and team memberships may be
73       done by any member of the organization.
74
75       Organization creation and management of team  admins  and  organization
76       members is done through the website, not the npm CLI.
77
78       To  use teams to manage permissions on packages belonging to your orga‐
79       nization, use the npm access command to grant or revoke the appropriate
80       permissions.
81
82   Configuration
83       <!--  AUTOGENERATED  CONFIG  DESCRIPTIONS  START --> <!-- automatically
84       generated, do not edit manually --> <!--  see  lib/utils/config/defini‐
85       tions.js -->
86
87   registry
88       • Default: "https://registry.npmjs.org/"
89
90       • Type: URL
91
92
93       The base URL of the npm registry.  <!-- automatically generated, do not
94       edit manually --> <!-- see lib/utils/config/definitions.js -->
95
96
97   otp
98       • Default: null
99
100       • Type: null or String
101
102
103       This is a one-time  password  from  a  two-factor  authenticator.  It's
104       needed when publishing or changing package permissions with npm access.
105
106       If  not  set,  and  a  registry  response  fails with a challenge for a
107       one-time password, npm will prompt on the command line for  one.   <!--
108       automatically   generated,   do   not   edit   manually  -->  <!--  see
109       lib/utils/config/definitions.js -->
110
111
112   parseable
113       • Default: false
114
115       • Type: Boolean
116
117
118       Output parseable results from commands that write to  standard  output.
119       For npm search, this will be tab-separated table format.  <!-- automat‐
120       ically generated, do not edit  manually  -->  <!--  see  lib/utils/con‐
121       fig/definitions.js -->
122
123
124   json
125       • Default: false
126
127       • Type: Boolean
128
129
130       Whether or not to output JSON data, rather than the normal output.
131
132       • In npm pkg set it enables parsing set values with JSON.parse() before
133         saving them to your package.json.
134
135
136       Not supported by all npm commands.  <!--  automatically  generated,  do
137       not edit manually --> <!-- see lib/utils/config/definitions.js -->
138
139       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
140
141
142   See Also
143       • npm help access
144
145       • npm help config
146
147       • npm help registry
148
149
150
151
152                                 January 2022                      NPM-TEAM(1)