gerrit/Documentation/cmd-plugin-ls.txt
David Myllykangas 511823f835 Documentation update for cmd-plugin
Update the Access section on documentation of the cmd-plugin
command to also include config to enable the command.

Change-Id: I815275009494db6ce3027a2705b0056146ba7a0f
2015-01-21 11:03:08 +09:00

44 lines
874 B
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
* Caller must be a member of the privileged 'Administrators' group.
* 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
---------