gerrit/Documentation/cmd-plugin-ls.txt
Edwin Kempin b3f31d8b6f Correct documentation of required capabilities for listing plugins
Change-Id: Ib1a38e6514be179af46bf513cb2918140cdd6f3e
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2015-04-30 00:58:28 +00:00

47 lines
1.0 KiB
Plaintext

= plugin ls
== NAME
plugin ls - List the installed plugins.
== SYNOPSIS
--
'ssh' -p <port> <host> 'gerrit plugin ls'
[--all | -a]
[--format {text | json | json_compact}]
--
== DESCRIPTION
List the installed plugins and show their version and status.
== ACCESS
* The caller must be a member of a group that is granted the
link:access-control.html#capability_viewPlugins[View Plugins]
capability or the link:access-control.html#capability_administrateServer[
Administrate Server] capability.
* link:config-gerrit.html#plugins.allowRemoteAdmin[plugins.allowRemoteAdmin]
must be enabled in `$site_path/etc/gerrit.config`.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
--all::
-a::
List all plugins, including disabled plugins.
--format::
What output format to display the results in.
+
--
`text`:: Simple text based format.
`json`:: Map of JSON objects describing each project.
`json_compact`:: Minimized JSON output.
--
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------