Skip to content

Commit e959e14

Browse files
committed
doc: add manpage for npm-org
1 parent 50463f5 commit e959e14

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

doc/cli/npm-org.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
npm-org(1) -- Manage orgs
2+
===================================
3+
4+
## SYNOPSIS
5+
6+
npm org set <orgname> <username> [developer | admin | owner]
7+
npm org rm <orgname> <username>
8+
npm org ls <orgname> [<username>]
9+
10+
## EXAMPLE
11+
12+
Add a new developer to an org:
13+
```
14+
$ npm org set my-org @mx-smith
15+
```
16+
17+
Add a new admin to an org (or change a developer to an admin):
18+
```
19+
$ npm org set my-org @mx-santos admin
20+
```
21+
22+
Remove a user from an org:
23+
```
24+
$ npm org rm my-org mx-santos
25+
```
26+
27+
List all users in an org:
28+
```
29+
$ npm org ls my-org
30+
```
31+
32+
List all users in JSON format:
33+
```
34+
$ npm org ls my-org --json
35+
```
36+
37+
See what role a user has in an org:
38+
```
39+
$ npm org ls my-org @mx-santos
40+
```
41+
42+
## DESCRIPTION
43+
44+
You can use the `npm org` commands to manage and view users of an organization.
45+
It supports adding and removing users, changing their roles, listing them, and
46+
finding specific ones and their roles.
47+
48+
## SEE ALSO
49+
50+
* [Documentation on npm Orgs](https://docs.npmjs.com/orgs/)

0 commit comments

Comments
 (0)