Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

npm-team (1)

Name

npm-team - Manage organization teams and team memberships Synopsis 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> Note: This command is unaware of workspaces. Description Used to manage teams in organizations, and change team memberships. Does not handle permissions for packages. Teams must always be fully qualified with the organization/scope they belong to when operating on them, separated by a colon (:). That is, if you have a newteam team in an org organization, you must always refer to that team as @org:newteam in these commands. If you have two-factor authentication enabled in auth-and-writes mode, then you can provide a code from your authenticator with [--otp <otp- code>]. If you don't include this then you will be prompted. o create / destroy: Create a new team, or destroy an existing one. Note: You cannot remove the developers team, <a href="https://docs.npmjs.com/about-developers-team" tar- get="_blank">learn more.</a> Here's how to create a new team newteam under the org org: npm team create @org:newteam You should see a confirming message such as: +@org:newteam once the new team has been created. o add: Add a user to an existing team. Adding a new user username to a team named newteam under the org org: npm team add @org:newteam username On success, you should see a message: username added to @org:newteam o rm: Using npm team rm you can also remove users from a team they belong to. Here's an example removing user username from newteam team in org organization: npm team rm @org:newteam username Once the user is removed a confirmation message is displayed: username removed from @org:newteam o 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. Here's an example of how to list all teams from an org named org: npm team ls @org Example listing all members of a team named newteam: npm team ls @org:newteam Details npm team always operates directly on the current registry, configurable from the command line using --registry=<registry url>. You must be a team admin to create teams and manage team membership, under the given organization. Listing teams and team memberships may be done by any member of the organization. Organization creation and management of team admins and organization members is done through the website, not the npm CLI. To use teams to manage permissions on packages belonging to your orga- nization, use the npm access command to grant or revoke the appropriate permissions. Configuration <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/defini- tions.js --> registry o Default: "https://registry.npmjs.org/" o Type: URL The base URL of the npm registry. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> otp o Default: null o Type: null or String This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with npm access. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> parseable o Default: false o Type: Boolean Output parseable results from commands that write to standard output. For npm search, this will be tab-separated table format. <!-- automat- ically generated, do not edit manually --> <!-- see lib/utils/con- fig/definitions.js --> json o Default: false o Type: Boolean Whether or not to output JSON data, rather than the normal output. o In npm pkg set it enables parsing set values with JSON.parse() before saving them to your package.json. Not supported by all npm commands. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> See Also o npm help access o npm help config o npm help registry

Synopsis

Please see following description for synopsis

Description

NPM-TEAM(1)                                                        NPM-TEAM(1)



NAME
       npm-team - Manage organization teams and team memberships

   Synopsis
         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>

       Note: This command is unaware of workspaces.

   Description
       Used  to  manage  teams  in organizations, and change team memberships.
       Does not handle permissions for packages.

       Teams must always be fully qualified with the  organization/scope  they
       belong to when operating on them, separated by a colon (:). That is, if
       you have a newteam team in an org organization, you must  always  refer
       to that team as @org:newteam in these commands.

       If  you have two-factor authentication enabled in auth-and-writes mode,
       then you can provide a code from your authenticator with  [--otp  <otp-
       code>].  If you don't include this then you will be prompted.

       o create  /  destroy:  Create  a  new team, or destroy an existing one.
         Note:    You    cannot    remove    the    developers    team,     <a
         href="https://docs.npmjs.com/about-developers-team"              tar-
         get="_blank">learn more.</a> Here's how to create a new team  newteam
         under the org org:

         npm team create @org:newteam
       You should see a confirming message such as: +@org:newteam once the new
       team has been created.

       o add: Add a user to an existing team.  Adding a new user username to a
         team named newteam under the org org:

         npm team add @org:newteam username
       On success, you should see a message: username added to @org:newteam

       o rm:  Using  npm  team  rm  you can also remove users from a team they
         belong to.  Here's an example removing  user  username  from  newteam
         team in org organization:

         npm team rm @org:newteam username
       Once  the user is removed a confirmation message is displayed: username
       removed from @org:newteam

       o 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.   Here's  an example of how to list all teams from an org named
         org:

         npm team ls @org
       Example listing all members of a team named newteam:

         npm team ls @org:newteam


   Details
       npm team always operates directly on the current registry, configurable
       from the command line using --registry=<registry url>.

       You  must  be  a team admin to create teams and manage team membership,
       under the given organization. Listing teams and team memberships may be
       done by any member of the organization.

       Organization  creation  and  management of team admins and organization
       members is done through the website, not the npm CLI.

       To use teams to manage permissions on packages belonging to your  orga-
       nization, use the npm access command to grant or revoke the appropriate
       permissions.

   Configuration
       <!-- AUTOGENERATED CONFIG DESCRIPTIONS  START  -->  <!--  automatically
       generated,  do  not edit manually --> <!-- see lib/utils/config/defini-
       tions.js -->

   registry
       o Default: "https://registry.npmjs.org/"

       o Type: URL


       The base URL of the npm registry.  <!-- automatically generated, do not
       edit manually --> <!-- see lib/utils/config/definitions.js -->


   otp
       o Default: null

       o Type: null or String


       This  is  a  one-time  password  from  a two-factor authenticator. It's
       needed when publishing or changing package permissions with npm access.

       If not set, and a registry  response  fails  with  a  challenge  for  a
       one-time  password,  npm will prompt on the command line for one.  <!--
       automatically  generated,  do  not   edit   manually   -->   <!--   see
       lib/utils/config/definitions.js -->


   parseable
       o Default: false

       o Type: Boolean


       Output  parseable  results from commands that write to standard output.
       For npm search, this will be tab-separated table format.  <!-- automat-
       ically  generated,  do  not  edit  manually --> <!-- see lib/utils/con-
       fig/definitions.js -->


   json
       o Default: false

       o Type: Boolean


       Whether or not to output JSON data, rather than the normal output.

       o In npm pkg set it enables parsing set values with JSON.parse() before
         saving them to your package.json.


       Not  supported  by  all npm commands.  <!-- automatically generated, do
       not edit manually --> <!-- see lib/utils/config/definitions.js -->

       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->


   See Also
       o npm help access

       o npm help config

       o npm help registry




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-16 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://github.com/nodejs/node/ar-
       chive/v16.11.1.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                 October 2021                      NPM-TEAM(1)