summaryrefslogtreecommitdiffstats
path: root/Documentation/cmd-set-members.txt
blob: 5fb2bb94ede8602779bc206b337d37f6cb930f4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
= gerrit set-members

== NAME
gerrit set-members - Set group members

== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit set-members_
  [--add USER ...]
  [--remove USER ...]
  [--include GROUP ...]
  [--exclude GROUP ...]
  [--]
  <GROUP> ...
--

== DESCRIPTION
Set the group members for the specified groups.

== OPTIONS
<GROUP>::
	Required; name of the group for which the members should be set.
	The members for multiple groups can be set at once by specifying
	multiple groups.

--add::
-a::
	A user that should be added to the specified groups. Multiple
	users can be added at once by using this option multiple times.

--remove::
-r::
	Remove this user from the specified groups. Multiple users can be
	removed at once by using this option multiple times.

--include::
-i::
	A group that should be included to the specified groups. Multiple
	groups can be included at once by using this option multiple
	times.

--exclude::
-e::
	Exclude this group from the specified groups. Multiple groups can
	be excluded at once by using this option multiple times.

The `set-members` command is processing the options in the following
order: `--remove`, `--exclude`, `--add`, `--include`

== ACCESS
Any user who has SSH access to Gerrit.

== SCRIPTING
This command is intended to be used in scripts.

== EXAMPLES

Add alice and bob, but remove eve from the groups my-committers and
my-verifiers.
----
	$ ssh -p 29418 review.example.com gerrit set-members \
	  -a alice@example.com -a bob@example.com \
	  -r eve@example.com my-committers my-verifiers
----

Include the group my-friends into the group my-committers, but
exclude the included group my-testers from the group my-committers.
----
	$ ssh -p 29418 review.example.com gerrit set-members \
	  -i my-friends -e my-testers my-committers
----

GERRIT
------
Part of link:index.html[Gerrit Code Review]

SEARCHBOX
---------