diff options
author | Kat Marchán <kzm@sykosomatic.org> | 2015-08-14 03:36:33 +0300 |
---|---|---|
committer | Rebecca Turner <me@re-becca.org> | 2015-08-14 22:25:49 +0300 |
commit | b15205d593250fd4019ccc8ee36b64e7a00f9e09 (patch) | |
tree | adb0b61e444c9cbd3af62f21eb999d45799a61fb /doc | |
parent | e833bb4a43077028f6dcc6f837e1c8e7230ff44b (diff) |
docs: added cli/npm-team.md describing npm team usage
PR-URL: https://github.com/npm/npm/pull/9011
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli/npm-team.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/cli/npm-team.md b/doc/cli/npm-team.md new file mode 100644 index 000000000..2ed9b367b --- /dev/null +++ b/doc/cli/npm-team.md @@ -0,0 +1,55 @@ +npm-team(1) -- Manage organization teams and team memberships +============================================================= + +## SYNOPSIS + + 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> + + npm team edit <scope:team> + +## DESCRIPTION + +Used to manage teams in organizations, and change team memberships. Does not +handle permissions for packages. + +Teams must always be fully qualified with the organization/scope they belond to +when operating on them, separated by a colon (`:`). That is, if you have a +`developers` team on a `foo` organization, you must always refer to that team as +`developers:foo` in these commands. + +* create / destroy: + Create a new team, or destroy an existing one. + +* add / rm: + Add a user to an existing team, or remove a user from a team they belong to. + +* 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. + +## DETAILS + +`npm team` always operates directly on the current registry, configurable from +the command line using `--registry=<registry url>`. + +In order to create teams and manage team membership, you must be a *team admin* +under the given organization. Listing teams and team memberships may be done by +any member of the organizations. + +Organization creation and management of team admins and *organization* members +is done through the website, not the npm CLI. + +To use teams to manage permissions on packages belonging to your organization, +use the `npm access` command to grant or revoke the appropriate permissions. + +## SEE ALSO + +* npm-access(1) +* npm-registr(7) |