| Edwin Kempin | cf6c359 | 2011-09-01 15:55:15 +0200 | [diff] [blame] | 1 | gerrit ls-groups |
| 2 | ================ |
| 3 | |
| 4 | NAME |
| 5 | ---- |
| 6 | gerrit ls-groups - List groups visible to caller |
| 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | [verse] |
| 11 | 'ssh' -p <port> <host> 'gerrit ls-groups' |
| Edwin Kempin | e11aeae | 2011-09-05 15:48:33 +0200 | [diff] [blame] | 12 | [--project <NAME>] |
| Edwin Kempin | 4d5f4b7 | 2011-09-06 13:12:53 +0200 | [diff] [blame] | 13 | [--visible-to-all] |
| Edwin Kempin | 6ac5fd6 | 2011-09-29 10:50:29 +0200 | [diff] [blame^] | 14 | [--type {internal | ldap | system}] |
| Edwin Kempin | cf6c359 | 2011-09-01 15:55:15 +0200 | [diff] [blame] | 15 | |
| 16 | DESCRIPTION |
| 17 | ----------- |
| 18 | Displays the list of group names, one per line, that are visible to |
| 19 | the account of the calling user. |
| 20 | |
| 21 | If the caller is a member of the privileged 'Administrators' group, |
| 22 | all groups are listed. |
| 23 | |
| 24 | ACCESS |
| 25 | ------ |
| 26 | Any user who has configured an SSH key. |
| 27 | |
| 28 | SCRIPTING |
| 29 | --------- |
| 30 | This command is intended to be used in scripts. |
| 31 | |
| Edwin Kempin | e11aeae | 2011-09-05 15:48:33 +0200 | [diff] [blame] | 32 | OPTIONS |
| 33 | ------- |
| 34 | --project:: |
| 35 | -p:: |
| 36 | Name of the project for which the groups should be listed. Only |
| 37 | groups are listed for which any permission is set on this project |
| 38 | (or for which a permission is inherited from a parent project). |
| 39 | Multiple --project options may be specified to specify additional |
| 40 | projects. In this case all groups are listed that have a |
| 41 | permission for any of the specified projects. |
| 42 | |
| Edwin Kempin | 4d5f4b7 | 2011-09-06 13:12:53 +0200 | [diff] [blame] | 43 | --visible-to-all:: |
| 44 | Displays only groups that are visible to all registered users |
| 45 | (groups that are explicitly marked as visible to all registered |
| 46 | users). |
| 47 | |
| Edwin Kempin | 6ac5fd6 | 2011-09-29 10:50:29 +0200 | [diff] [blame^] | 48 | --type:: |
| 49 | Display only groups of the specified type. If not specified, |
| 50 | groups of all types are displayed. Supported types: |
| 51 | + |
| 52 | -- |
| 53 | `internal`:: Any group defined within Gerrit. |
| 54 | `ldap`:: Any group defined by an external LDAP database. |
| 55 | `system`:: Any system defined and managed group. |
| 56 | -- |
| 57 | |
| Edwin Kempin | cf6c359 | 2011-09-01 15:55:15 +0200 | [diff] [blame] | 58 | EXAMPLES |
| 59 | -------- |
| 60 | |
| 61 | List visible groups: |
| 62 | ===== |
| 63 | $ ssh -p 29418 review.example.com gerrit ls-groups |
| 64 | Administrators |
| 65 | Anonymous Users |
| 66 | MyProject_Committers |
| 67 | Project Owners |
| 68 | Registered Users |
| 69 | ===== |
| 70 | |
| Edwin Kempin | e11aeae | 2011-09-05 15:48:33 +0200 | [diff] [blame] | 71 | List all groups for which any permission is set for the project |
| 72 | "MyProject": |
| 73 | ===== |
| 74 | $ ssh -p 29418 review.example.com gerrit ls-groups --project MyProject |
| 75 | MyProject_Committers |
| 76 | Project Owners |
| 77 | Registered Users |
| 78 | ===== |
| 79 | |
| Edwin Kempin | cf6c359 | 2011-09-01 15:55:15 +0200 | [diff] [blame] | 80 | GERRIT |
| 81 | ------ |
| 82 | Part of link:index.html[Gerrit Code Review] |
