123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285 |
- <html><head>
- <title>npm-team</title>
- <style>
- body {
- background-color: #ffffff;
- color: #24292e;
- margin: 0;
- line-height: 1.5;
- font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
- }
- #rainbar {
- height: 10px;
- background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
- }
- a {
- text-decoration: none;
- color: #0366d6;
- }
- a:hover {
- text-decoration: underline;
- }
- pre {
- margin: 1em 0px;
- padding: 1em;
- border: solid 1px #e1e4e8;
- border-radius: 6px;
- display: block;
- overflow: auto;
- white-space: pre;
- background-color: #f6f8fa;
- color: #393a34;
- }
- code {
- font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
- font-size: 85%;
- padding: 0.2em 0.4em;
- background-color: #f6f8fa;
- color: #393a34;
- }
- pre > code {
- padding: 0;
- background-color: inherit;
- color: inherit;
- }
- h1, h2, h3 {
- font-weight: 600;
- }
- #logobar {
- background-color: #333333;
- margin: 0 auto;
- padding: 1em 4em;
- }
- #logobar .logo {
- float: left;
- }
- #logobar .title {
- font-weight: 600;
- color: #dddddd;
- float: left;
- margin: 5px 0 0 1em;
- }
- #logobar:after {
- content: "";
- display: block;
- clear: both;
- }
- #content {
- margin: 0 auto;
- padding: 0 4em;
- }
- #table_of_contents > h2 {
- font-size: 1.17em;
- }
- #table_of_contents ul:first-child {
- border: solid 1px #e1e4e8;
- border-radius: 6px;
- padding: 1em;
- background-color: #f6f8fa;
- color: #393a34;
- }
- #table_of_contents ul {
- list-style-type: none;
- padding-left: 1.5em;
- }
- #table_of_contents li {
- font-size: 0.9em;
- }
- #table_of_contents li a {
- color: #000000;
- }
- header.title {
- border-bottom: solid 1px #e1e4e8;
- }
- header.title > h1 {
- margin-bottom: 0.25em;
- }
- header.title > .description {
- display: block;
- margin-bottom: 0.5em;
- line-height: 1;
- }
- footer#edit {
- border-top: solid 1px #e1e4e8;
- margin: 3em 0 4em 0;
- padding-top: 2em;
- }
- </style>
- </head>
- <body>
- <div id="banner">
- <div id="rainbar"></div>
- <div id="logobar">
- <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
- <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
- <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
- </svg>
- <div class="title">
- npm command-line interface
- </div>
- </div>
- </div>
- <section id="content">
- <header class="title">
- <h1 id="npm-team">npm-team</h1>
- <span class="description">Manage organization teams and team memberships</span>
- </header>
- <section id="table_of_contents">
- <h2 id="table-of-contents">Table of contents</h2>
- <div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#details">Details</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="#parseable"><code>parseable</code></a></li><li><a href="#json"><code>json</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
- </section>
- <div id="_content"><h3 id="synopsis">Synopsis</h3>
- <pre lang="bash"><code>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>
- </code></pre>
- <p>Note: This command is unaware of workspaces.</p>
- <h3 id="description">Description</h3>
- <p>Used to manage teams in organizations, and change team memberships. Does not
- handle permissions for packages.</p>
- <p>Teams must always be fully qualified with the organization/scope they belong to
- when operating on them, separated by a colon (<code>:</code>). That is, if you have a
- <code>newteam</code> team in an <code>org</code> organization, you must always refer to that team
- as <code>@org:newteam</code> in these commands.</p>
- <p>If you have two-factor authentication enabled in <code>auth-and-writes</code> mode, then
- you can provide a code from your authenticator with <code>[--otp <otpcode>]</code>.
- If you don’t include this then you will be prompted.</p>
- <ul>
- <li>
- <p>create / destroy:
- Create a new team, or destroy an existing one. Note: You cannot remove the
- <code>developers</code> team, <!-- raw HTML omitted -->learn more.<!-- raw HTML omitted --></p>
- <p>Here’s how to create a new team <code>newteam</code> under the <code>org</code> org:</p>
- <pre lang="bash"><code>npm team create @org:newteam
- </code></pre>
- <p>You should see a confirming message such as: <code>+@org:newteam</code> once the new
- team has been created.</p>
- </li>
- <li>
- <p>add:
- Add a user to an existing team.</p>
- <p>Adding a new user <code>username</code> to a team named <code>newteam</code> under the <code>org</code> org:</p>
- <pre lang="bash"><code>npm team add @org:newteam username
- </code></pre>
- <p>On success, you should see a message: <code>username added to @org:newteam</code></p>
- </li>
- <li>
- <p>rm:
- Using <code>npm team rm</code> you can also remove users from a team they belong to.</p>
- <p>Here’s an example removing user <code>username</code> from <code>newteam</code> team
- in <code>org</code> organization:</p>
- <pre lang="bash"><code>npm team rm @org:newteam username
- </code></pre>
- <p>Once the user is removed a confirmation message is displayed:
- <code>username removed from @org:newteam</code></p>
- </li>
- <li>
- <p>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.</p>
- <p>Here’s an example of how to list all teams from an org named <code>org</code>:</p>
- <pre lang="bash"><code>npm team ls @org
- </code></pre>
- <p>Example listing all members of a team named <code>newteam</code>:</p>
- <pre lang="bash"><code>npm team ls @org:newteam
- </code></pre>
- </li>
- </ul>
- <h3 id="details">Details</h3>
- <p><code>npm team</code> always operates directly on the current registry, configurable from
- the command line using <code>--registry=<registry url></code>.</p>
- <p>You must be a <em>team admin</em> 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.</p>
- <p>Organization creation and management of team admins and <em>organization</em> members
- is done through the website, not the npm CLI.</p>
- <p>To use teams to manage permissions on packages belonging to your organization,
- use the <code>npm access</code> command to grant or revoke the appropriate permissions.</p>
- <h3 id="configuration">Configuration</h3>
- <!-- raw HTML omitted -->
- <!-- raw HTML omitted -->
- <!-- raw HTML omitted -->
- <h4 id="registry"><code>registry</code></h4>
- <ul>
- <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li>
- <li>Type: URL</li>
- </ul>
- <p>The base URL of the npm registry.</p>
- <!-- raw HTML omitted -->
- <!-- raw HTML omitted -->
- <h4 id="otp"><code>otp</code></h4>
- <ul>
- <li>Default: null</li>
- <li>Type: null or String</li>
- </ul>
- <p>This is a one-time password from a two-factor authenticator. It’s needed
- when publishing or changing package permissions with <code>npm access</code>.</p>
- <p>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.</p>
- <!-- raw HTML omitted -->
- <!-- raw HTML omitted -->
- <h4 id="parseable"><code>parseable</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>Output parseable results from commands that write to standard output. For
- <code>npm search</code>, this will be tab-separated table format.</p>
- <!-- raw HTML omitted -->
- <!-- raw HTML omitted -->
- <h4 id="json"><code>json</code></h4>
- <ul>
- <li>Default: false</li>
- <li>Type: Boolean</li>
- </ul>
- <p>Whether or not to output JSON data, rather than the normal output.</p>
- <ul>
- <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
- saving them to your <code>package.json</code>.</li>
- </ul>
- <p>Not supported by all npm commands.</p>
- <!-- raw HTML omitted -->
- <!-- raw HTML omitted -->
- <!-- raw HTML omitted -->
- <h3 id="see-also">See Also</h3>
- <ul>
- <li><a href="../commands/npm-access.html">npm access</a></li>
- <li><a href="../commands/npm-config.html">npm config</a></li>
- <li><a href="../using-npm/registry.html">npm registry</a></li>
- </ul>
- </div>
- <footer id="edit">
- <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-team.md">
- <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
- <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>
- </svg>
- Edit this page on GitHub
- </a>
- </footer>
- </section>
- </body></html>
|