blob: 22b63d71bb42fafb77d03461d5e6b6935918b9c9 [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--------
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080012--
Edwin Kempinf7295742012-07-16 15:03:46 +020013'ssh' -p <port> <host> 'gerrit plugin install | add'
14 [--name <NAME> | -n <NAME>]
15 - | <URL> | <PATH>
Yuxuan 'fishy' Wangd85b6872013-11-15 11:47:46 -080016--
Edwin Kempinf7295742012-07-16 15:03:46 +020017
18DESCRIPTION
19-----------
20Install/Add a plugin. The plugin will be copied into the site path's
21`plugins` directory.
22
23ACCESS
24------
25Caller must be a member of the privileged 'Administrators' group.
26
27SCRIPTING
28---------
29This command is intended to be used in scripts.
30
31OPTIONS
32-------
33-::
Dariusz Luksza357a2422012-11-12 06:16:26 +010034Plugin jar or js as piped input.
Edwin Kempinf7295742012-07-16 15:03:46 +020035
36<URL>::
37URL from where the plugin should be downloaded. This can be an
38HTTP or FTP site.
39
40<PATH>::
Dariusz Luksza357a2422012-11-12 06:16:26 +010041Absolute file path to the plugin jar or js.
Edwin Kempinf7295742012-07-16 15:03:46 +020042
43--name::
44-n::
David Ostrovsky366ad0e2013-09-05 19:59:09 +020045The name under which the plugin should be installed. Note: if the plugin
46provides its own name in the MANIFEST file, then the plugin name from the
47MANIFEST file has precedence over this option.
Edwin Kempinf7295742012-07-16 15:03:46 +020048
49EXAMPLES
50--------
51Install a plugin from an absolute file path on the server's host:
52
53====
Dariusz Luksza357a2422012-11-12 06:16:26 +010054ssh -p 29418 localhost gerrit plugin install -n name.jar \
Edwin Kempinf7295742012-07-16 15:03:46 +020055 $(pwd)/my-plugin.jar
56====
57
Dariusz Luksza357a2422012-11-12 06:16:26 +010058Install a WebUi plugin from an absolute file path on the server's host:
59
60====
61 ssh -p 29418 localhost gerrit plugin install -n name.js \
62 $(pwd)/my-webui-plugin.js
63====
64
Edwin Kempinf7295742012-07-16 15:03:46 +020065Install a plugin from an HTTP site:
66
67====
Dariusz Luksza357a2422012-11-12 06:16:26 +010068ssh -p 29418 localhost gerrit plugin install -n name.jar \
69 http://build-server/output/our-plugin
Edwin Kempinf7295742012-07-16 15:03:46 +020070====
71
72Install a plugin from piped input:
73
74====
Dariusz Luksza357a2422012-11-12 06:16:26 +010075ssh -p 29418 localhost gerrit plugin install -n name.jar \
Edwin Kempinf7295742012-07-16 15:03:46 +020076 - <target/name-0.1.jar
77====
78
79GERRIT
80------
81Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -070082
83SEARCHBOX
84---------