npm-team.1 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .TH "NPM\-TEAM" "1" "August 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-team\fR \- Manage organization teams and team memberships
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm team create <scope:team>
  9. npm team destroy <scope:team>
  10. npm team add <scope:team> <user>
  11. npm team rm <scope:team> <user>
  12. npm team ls <scope>|<scope:team>
  13. npm team edit <scope:team>
  14. .fi
  15. .RE
  16. .SS Description
  17. .P
  18. Used to manage teams in organizations, and change team memberships\. Does not
  19. handle permissions for packages\.
  20. .P
  21. Teams must always be fully qualified with the organization/scope they belong to
  22. 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\.
  23. .P
  24. 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\.
  25. .RS 0
  26. .IP \(bu 2
  27. create / destroy:
  28. 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>
  29. .IP \(bu 2
  30. add / rm:
  31. Add a user to an existing team, or remove a user from a team they belong to\.
  32. .IP \(bu 2
  33. ls:
  34. If performed on an organization name, will return a list of existing teams
  35. under that organization\. If performed on a team, it will instead return a list
  36. of all users belonging to that particular team\.
  37. .IP \(bu 2
  38. edit:
  39. Edit a current team\.
  40. .RE
  41. .SS Details
  42. .P
  43. \fBnpm team\fP always operates directly on the current registry, configurable from
  44. the command line using \fB\-\-registry=<registry url>\fP\|\.
  45. .P
  46. In order to create teams and manage team membership, you must be a \fIteam admin\fR
  47. under the given organization\. Listing teams and team memberships may be done by
  48. any member of the organizations\.
  49. .P
  50. Organization creation and management of team admins and \fIorganization\fR members
  51. is done through the website, not the npm CLI\.
  52. .P
  53. To use teams to manage permissions on packages belonging to your organization,
  54. use the \fBnpm access\fP command to grant or revoke the appropriate permissions\.
  55. .SS See Also
  56. .RS 0
  57. .IP \(bu 2
  58. npm help access
  59. .IP \(bu 2
  60. npm help registry
  61. .RE