summaryrefslogtreecommitdiffstats
path: root/Documentation/cmd-plugin-ls.txt
blob: d329db5ced40e21ec709e87bf4bd0638b404cf6e (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
= plugin ls

== NAME
plugin ls - List the installed plugins.

== SYNOPSIS
[verse]
--
_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
---------