blob: 5cdf9199c0b46b1fa21dac15b467bb01be63ae0a [file] [log] [blame]
James E. Blair4ce47da2013-12-05 14:06:08 -08001:title: Zuul Client
2
3Zuul Client
4===========
5
6Zuul includes a simple command line client that may be used by
7administrators to affect Zuul's behavior while running. It must be
8run on a host that has access to the Gearman server (e.g., locally on
9the Zuul host).
10
11Configuration
12-------------
13
14The client uses the same zuul.conf file as the server, and will look
15for it in the same locations if not specified on the command line.
16
17Usage
18-----
19The general options that apply to all subcommands are:
20
21.. program-output:: zuul --help
22
23The following subcommands are supported:
24
David Shrewsburyffab07a2017-07-24 12:45:07 -040025Autohold
26^^^^^^^^
27.. program-output:: zuul autohold --help
28
29Example::
30
31 zuul autohold --tenant openstack --project example_project --job example_job ---count 1
32
James E. Blair4ce47da2013-12-05 14:06:08 -080033Enqueue
34^^^^^^^
35.. program-output:: zuul enqueue --help
36
37Example::
38
Paul Belangerbaca3132016-11-04 12:49:54 -040039 zuul enqueue --tenant openstack --trigger gerrit --pipeline check --project example_project --change 12345,1
Akihiro Motoki7109dc62014-02-10 19:09:28 +090040
41Note that the format of change id is <number>,<patchset>.
Antoine Musso6aa89842014-06-30 21:35:26 +020042
43Promote
44^^^^^^^
45.. program-output:: zuul promote --help
46
47Example::
48
Paul Belangerbaca3132016-11-04 12:49:54 -040049 zuul promote --tenant openstack --pipeline check --changes 12345,1 13336,3
Antoine Musso6aa89842014-06-30 21:35:26 +020050
51Note that the format of changes id is <number>,<patchset>.
52
53Show
54^^^^
55.. program-output:: zuul show --help
56
57Example::
58
59 zuul show running-jobs