npm-org.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. <html><head>
  2. <title>npm-org</title>
  3. <style>
  4. body {
  5. background-color: #ffffff;
  6. color: #24292e;
  7. margin: 0;
  8. line-height: 1.5;
  9. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  10. }
  11. #rainbar {
  12. height: 10px;
  13. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  14. }
  15. a {
  16. text-decoration: none;
  17. color: #0366d6;
  18. }
  19. a:hover {
  20. text-decoration: underline;
  21. }
  22. pre {
  23. margin: 1em 0px;
  24. padding: 1em;
  25. border: solid 1px #e1e4e8;
  26. border-radius: 6px;
  27. display: block;
  28. overflow: auto;
  29. white-space: pre;
  30. background-color: #f6f8fa;
  31. color: #393a34;
  32. }
  33. code {
  34. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  35. font-size: 85%;
  36. padding: 0.2em 0.4em;
  37. background-color: #f6f8fa;
  38. color: #393a34;
  39. }
  40. pre > code {
  41. padding: 0;
  42. background-color: inherit;
  43. color: inherit;
  44. }
  45. h1, h2, h3 {
  46. font-weight: 600;
  47. }
  48. #logobar {
  49. background-color: #333333;
  50. margin: 0 auto;
  51. padding: 1em 4em;
  52. }
  53. #logobar .logo {
  54. float: left;
  55. }
  56. #logobar .title {
  57. font-weight: 600;
  58. color: #dddddd;
  59. float: left;
  60. margin: 5px 0 0 1em;
  61. }
  62. #logobar:after {
  63. content: "";
  64. display: block;
  65. clear: both;
  66. }
  67. #content {
  68. margin: 0 auto;
  69. padding: 0 4em;
  70. }
  71. #table_of_contents > h2 {
  72. font-size: 1.17em;
  73. }
  74. #table_of_contents ul:first-child {
  75. border: solid 1px #e1e4e8;
  76. border-radius: 6px;
  77. padding: 1em;
  78. background-color: #f6f8fa;
  79. color: #393a34;
  80. }
  81. #table_of_contents ul {
  82. list-style-type: none;
  83. padding-left: 1.5em;
  84. }
  85. #table_of_contents li {
  86. font-size: 0.9em;
  87. }
  88. #table_of_contents li a {
  89. color: #000000;
  90. }
  91. header.title {
  92. border-bottom: solid 1px #e1e4e8;
  93. }
  94. header.title > h1 {
  95. margin-bottom: 0.25em;
  96. }
  97. header.title > .description {
  98. display: block;
  99. margin-bottom: 0.5em;
  100. line-height: 1;
  101. }
  102. footer#edit {
  103. border-top: solid 1px #e1e4e8;
  104. margin: 3em 0 4em 0;
  105. padding-top: 2em;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div id="banner">
  111. <div id="rainbar"></div>
  112. <div id="logobar">
  113. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  114. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  115. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  116. </svg>
  117. <div class="title">
  118. npm command-line interface
  119. </div>
  120. </div>
  121. </div>
  122. <section id="content">
  123. <header class="title">
  124. <h1 id="npm-org">npm-org</h1>
  125. <span class="description">Manage orgs</span>
  126. </header>
  127. <section id="table_of_contents">
  128. <h2 id="table-of-contents">Table of contents</h2>
  129. <div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#example">Example</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#registry"><code>registry</code></a></li><li><a href="#otp"><code>otp</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#parseable"><code>parseable</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
  130. </section>
  131. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  132. <pre lang="bash"><code>npm org set &lt;orgname&gt; &lt;username&gt; [developer | admin | owner]
  133. npm org rm &lt;orgname&gt; &lt;username&gt;
  134. npm org ls &lt;orgname&gt; [&lt;username&gt;]
  135. </code></pre>
  136. <p>Note: This command is unaware of workspaces.</p>
  137. <h3 id="example">Example</h3>
  138. <p>Add a new developer to an org:</p>
  139. <pre lang="bash"><code>$ npm org set my-org @mx-smith
  140. </code></pre>
  141. <p>Add a new admin to an org (or change a developer to an admin):</p>
  142. <pre lang="bash"><code>$ npm org set my-org @mx-santos admin
  143. </code></pre>
  144. <p>Remove a user from an org:</p>
  145. <pre lang="bash"><code>$ npm org rm my-org mx-santos
  146. </code></pre>
  147. <p>List all users in an org:</p>
  148. <pre lang="bash"><code>$ npm org ls my-org
  149. </code></pre>
  150. <p>List all users in JSON format:</p>
  151. <pre lang="bash"><code>$ npm org ls my-org --json
  152. </code></pre>
  153. <p>See what role a user has in an org:</p>
  154. <pre lang="bash"><code>$ npm org ls my-org @mx-santos
  155. </code></pre>
  156. <h3 id="description">Description</h3>
  157. <p>You can use the <code>npm org</code> commands to manage and view users of an
  158. organization. It supports adding and removing users, changing their roles,
  159. listing them, and finding specific ones and their roles.</p>
  160. <h3 id="configuration">Configuration</h3>
  161. <!-- raw HTML omitted -->
  162. <!-- raw HTML omitted -->
  163. <!-- raw HTML omitted -->
  164. <h4 id="registry"><code>registry</code></h4>
  165. <ul>
  166. <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li>
  167. <li>Type: URL</li>
  168. </ul>
  169. <p>The base URL of the npm registry.</p>
  170. <!-- raw HTML omitted -->
  171. <!-- raw HTML omitted -->
  172. <h4 id="otp"><code>otp</code></h4>
  173. <ul>
  174. <li>Default: null</li>
  175. <li>Type: null or String</li>
  176. </ul>
  177. <p>This is a one-time password from a two-factor authenticator. It’s needed
  178. when publishing or changing package permissions with <code>npm access</code>.</p>
  179. <p>If not set, and a registry response fails with a challenge for a one-time
  180. password, npm will prompt on the command line for one.</p>
  181. <!-- raw HTML omitted -->
  182. <!-- raw HTML omitted -->
  183. <h4 id="json"><code>json</code></h4>
  184. <ul>
  185. <li>Default: false</li>
  186. <li>Type: Boolean</li>
  187. </ul>
  188. <p>Whether or not to output JSON data, rather than the normal output.</p>
  189. <ul>
  190. <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
  191. saving them to your <code>package.json</code>.</li>
  192. </ul>
  193. <p>Not supported by all npm commands.</p>
  194. <!-- raw HTML omitted -->
  195. <!-- raw HTML omitted -->
  196. <h4 id="parseable"><code>parseable</code></h4>
  197. <ul>
  198. <li>Default: false</li>
  199. <li>Type: Boolean</li>
  200. </ul>
  201. <p>Output parseable results from commands that write to standard output. For
  202. <code>npm search</code>, this will be tab-separated table format.</p>
  203. <!-- raw HTML omitted -->
  204. <!-- raw HTML omitted -->
  205. <!-- raw HTML omitted -->
  206. <h3 id="see-also">See Also</h3>
  207. <ul>
  208. <li><a href="../using-npm/orgs.html">using orgs</a></li>
  209. <li><a href="https://docs.npmjs.com/orgs/">Documentation on npm Orgs</a></li>
  210. </ul>
  211. </div>
  212. <footer id="edit">
  213. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-org.md">
  214. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  215. <path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
  216. </svg>
  217. Edit this page on GitHub
  218. </a>
  219. </footer>
  220. </section>
  221. </body></html>