npm-org.1 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. .TH "NPM-ORG" "1" "March 2026" "NPM@11.12.0" ""
  2. .SH "NAME"
  3. \fBnpm-org\fR - Manage orgs
  4. .SS "Synopsis"
  5. .P
  6. .RS 2
  7. .nf
  8. npm org set orgname username \[lB]developer | admin | owner\[rB]
  9. npm org rm orgname username
  10. npm org ls orgname \[lB]<username>\[rB]
  11. alias: ogr
  12. .fi
  13. .RE
  14. .P
  15. Note: This command is unaware of workspaces.
  16. .SS "Example"
  17. .P
  18. Add a new developer to an org:
  19. .P
  20. .RS 2
  21. .nf
  22. $ npm org set my-org @mx-smith
  23. .fi
  24. .RE
  25. .P
  26. Add a new admin to an org (or change a developer to an admin):
  27. .P
  28. .RS 2
  29. .nf
  30. $ npm org set my-org @mx-santos admin
  31. .fi
  32. .RE
  33. .P
  34. Remove a user from an org:
  35. .P
  36. .RS 2
  37. .nf
  38. $ npm org rm my-org mx-santos
  39. .fi
  40. .RE
  41. .P
  42. List all users in an org:
  43. .P
  44. .RS 2
  45. .nf
  46. $ npm org ls my-org
  47. .fi
  48. .RE
  49. .P
  50. List all users in JSON format:
  51. .P
  52. .RS 2
  53. .nf
  54. $ npm org ls my-org --json
  55. .fi
  56. .RE
  57. .P
  58. See what role a user has in an org:
  59. .P
  60. .RS 2
  61. .nf
  62. $ npm org ls my-org @mx-santos
  63. .fi
  64. .RE
  65. .SS "Description"
  66. .P
  67. You can use the \fBnpm org\fR commands to manage and view users of an organization. It supports adding and removing users, changing their roles, listing them, and finding specific ones and their roles.
  68. .SS "Configuration"
  69. .SS "\fBregistry\fR"
  70. .RS 0
  71. .IP \(bu 4
  72. Default: "https://registry.npmjs.org/"
  73. .IP \(bu 4
  74. Type: URL
  75. .RE 0
  76. .P
  77. The base URL of the npm registry.
  78. .SS "\fBotp\fR"
  79. .RS 0
  80. .IP \(bu 4
  81. Default: null
  82. .IP \(bu 4
  83. Type: null or String
  84. .RE 0
  85. .P
  86. This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with \fBnpm access\fR.
  87. .P
  88. 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.
  89. .SS "\fBjson\fR"
  90. .RS 0
  91. .IP \(bu 4
  92. Default: false
  93. .IP \(bu 4
  94. Type: Boolean
  95. .RE 0
  96. .P
  97. Whether or not to output JSON data, rather than the normal output.
  98. .RS 0
  99. .IP \(bu 4
  100. In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.
  101. .RE 0
  102. .P
  103. Not supported by all npm commands.
  104. .SS "\fBparseable\fR"
  105. .RS 0
  106. .IP \(bu 4
  107. Default: false
  108. .IP \(bu 4
  109. Type: Boolean
  110. .RE 0
  111. .P
  112. Output parseable results from commands that write to standard output. For \fBnpm search\fR, this will be tab-separated table format.
  113. .SS "See Also"
  114. .RS 0
  115. .IP \(bu 4
  116. npm help "using orgs"
  117. .IP \(bu 4
  118. \fBDocumentation on npm Orgs\fR \fI\(lahttps://docs.npmjs.com/orgs/\(ra\fR
  119. .RE 0