blob: 719c2bc469a31866fe1f809b7d2d8da5209ebf54 [file] [log] [blame]
Edwin Kempinf7295742012-07-16 15:03:46 +02001plugin install
2==============
3
4NAME
5----
6plugin install - Install/Add a plugin.
7
8plugin add - Install/Add a plugin.
9
10SYNOPSIS
11--------
12[verse]
13'ssh' -p <port> <host> 'gerrit plugin install | add'
14 [--name <NAME> | -n <NAME>]
15 - | <URL> | <PATH>
16
17DESCRIPTION
18-----------
19Install/Add a plugin. The plugin will be copied into the site path's
20`plugins` directory.
21
22ACCESS
23------
24Caller must be a member of the privileged 'Administrators' group.
25
26SCRIPTING
27---------
28This command is intended to be used in scripts.
29
30OPTIONS
31-------
32-::
33Plugin jar as piped input.
34
35<URL>::
36URL from where the plugin should be downloaded. This can be an
37HTTP or FTP site.
38
39<PATH>::
40Absolute file path to the plugin jar.
41
42--name::
43-n::
David Ostrovsky366ad0e2013-09-05 19:59:09 +020044The name under which the plugin should be installed. Note: if the plugin
45provides its own name in the MANIFEST file, then the plugin name from the
46MANIFEST file has precedence over this option.
Edwin Kempinf7295742012-07-16 15:03:46 +020047
48EXAMPLES
49--------
50Install a plugin from an absolute file path on the server's host:
51
52====
53ssh -p 29418 localhost gerrit plugin install -n name \
54 $(pwd)/my-plugin.jar
55====
56
57Install a plugin from an HTTP site:
58
59====
60ssh -p 29418 localhost gerrit plugin install -n name \
61 http://build-server/output/our-plugin.jar
62====
63
64Install a plugin from piped input:
65
66====
67ssh -p 29418 localhost gerrit plugin install -n name \
68 - <target/name-0.1.jar
69====
70
71GERRIT
72------
73Part of link:index.html[Gerrit Code Review]