| Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 1 | = plugin ls |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 2 | |
| Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 3 | == NAME |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 4 | plugin ls - List the installed plugins. |
| 5 | |
| Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 6 | == SYNOPSIS |
| Michael Ochmann | e2d76a1 | 2016-06-23 17:07:37 +0200 | [diff] [blame] | 7 | [verse] |
| Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 8 | -- |
| Michael Ochmann | e2d76a1 | 2016-06-23 17:07:37 +0200 | [diff] [blame] | 9 | _ssh_ -p <port> <host> _gerrit plugin ls_ |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 10 | [--all | -a] |
| 11 | [--format {text | json | json_compact}] |
| Yuxuan 'fishy' Wang | d85b687 | 2013-11-15 11:47:46 -0800 | [diff] [blame] | 12 | -- |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 13 | |
| Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 14 | == DESCRIPTION |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 15 | List the installed plugins and show their version and status. |
| 16 | |
| Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 17 | == ACCESS |
| Edwin Kempin | b3f31d8 | 2015-04-29 14:24:23 +0200 | [diff] [blame] | 18 | * The caller must be a member of a group that is granted the |
| 19 | link:access-control.html#capability_viewPlugins[View Plugins] |
| 20 | capability or the link:access-control.html#capability_administrateServer[ |
| 21 | Administrate Server] capability. |
| David Myllykangas | 511823f | 2015-01-20 16:34:57 +0100 | [diff] [blame] | 22 | * link:config-gerrit.html#plugins.allowRemoteAdmin[plugins.allowRemoteAdmin] |
| Edwin Kempin | b3f31d8 | 2015-04-29 14:24:23 +0200 | [diff] [blame] | 23 | must be enabled in `$site_path/etc/gerrit.config`. |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 24 | |
| Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 25 | == SCRIPTING |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 26 | This command is intended to be used in scripts. |
| 27 | |
| Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 28 | == OPTIONS |
| Edwin Kempin | f729574 | 2012-07-16 15:03:46 +0200 | [diff] [blame] | 29 | --all:: |
| 30 | -a:: |
| 31 | List all plugins, including disabled plugins. |
| 32 | |
| 33 | --format:: |
| 34 | What output format to display the results in. |
| 35 | + |
| 36 | -- |
| 37 | `text`:: Simple text based format. |
| 38 | `json`:: Map of JSON objects describing each project. |
| 39 | `json_compact`:: Minimized JSON output. |
| 40 | -- |
| 41 | |
| 42 | GERRIT |
| 43 | ------ |
| 44 | Part of link:index.html[Gerrit Code Review] |
| Yuxuan 'fishy' Wang | 99cb68d | 2013-10-31 17:26:00 -0700 | [diff] [blame] | 45 | |
| 46 | SEARCHBOX |
| 47 | --------- |
