diff options
author | Kat Marchán <kzm@zkat.tech> | 2019-01-18 20:05:58 +0300 |
---|---|---|
committer | Kat Marchán <kzm@zkat.tech> | 2019-01-18 20:09:54 +0300 |
commit | e959e14217d751ddb295565fd75cc81de1ee0d5b (patch) | |
tree | 58607cee629564657e1d182abc5864671b59a072 /doc | |
parent | 50463f58b4b70180a85d6d8c10fcf50d8970ef5e (diff) |
doc: add manpage for npm-org
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli/npm-org.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/cli/npm-org.md b/doc/cli/npm-org.md new file mode 100644 index 000000000..802df4df5 --- /dev/null +++ b/doc/cli/npm-org.md @@ -0,0 +1,50 @@ +npm-org(1) -- Manage orgs +=================================== + +## SYNOPSIS + + npm org set <orgname> <username> [developer | admin | owner] + npm org rm <orgname> <username> + npm org ls <orgname> [<username>] + +## EXAMPLE + +Add a new developer to an org: +``` +$ npm org set my-org @mx-smith +``` + +Add a new admin to an org (or change a developer to an admin): +``` +$ npm org set my-org @mx-santos admin +``` + +Remove a user from an org: +``` +$ npm org rm my-org mx-santos +``` + +List all users in an org: +``` +$ npm org ls my-org +``` + +List all users in JSON format: +``` +$ npm org ls my-org --json +``` + +See what role a user has in an org: +``` +$ npm org ls my-org @mx-santos +``` + +## DESCRIPTION + +You can use the `npm org` 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. + +## SEE ALSO + +* [Documentation on npm Orgs](https://docs.npmjs.com/orgs/) |