1bugzilla(1)                      User Commands                     bugzilla(1)
2
3
4

NAME

6       bugzilla - command-line interface to Bugzilla over XML-RPC
7

SYNOPSIS

9       bugzilla [options] [command] [command-options]
10

DESCRIPTION

12       bugzilla  is  a  command-line utility that allows access to the XML-RPC
13       interface provided by Bugzilla.
14
15       command is one of:
16        * login - log into the given bugzilla instance
17        * new - create a new bug
18        * query - search for bugs matching given criteria
19        * modify - modify existing bugs
20        * attach - attach files to existing bugs, or get attachments
21        * info - get info about the given bugzilla instance
22

GLOBAL OPTIONS

24       --version
25              show program's version number and exit
26
27       --help, -h
28              show this help message and exit
29
30       --bugzilla=BUGZILLA
31              bugzilla XMLRPC URI.  default:  https://bugzilla.redhat.com/xml
32              rpc.cgi
33
34       --nosslverify
35              Don't error on invalid bugzilla SSL certificate
36
37       --cert=CERTFILE
38              client side certificate file needed by the webserver.
39
40       --login
41              Run interactive "login" before performing the specified command.
42
43       --username=USERNAME
44              Log in with this username
45
46       --password=PASSWORD
47              Log in with this password
48
49       --ensure-logged-in
50              Raise  an  error  if  we  aren't logged in to bugzilla. Consider
51              using this if you are depending on cached credentials, to ensure
52              that when they expire the tool errors, rather than subtly change
53              output.
54
55       --no-cache-credentials
56              Don't save any bugzilla cookies or tokens to disk, and don't use
57              any pre-existing credentials.
58
59       --cookiefile=COOKIEFILE
60              cookie file to use for bugzilla authentication
61
62       --tokenfile=TOKENFILE
63              token file to use for bugzilla authentication
64
65       --verbose
66              give more info about what's going on
67
68       --debug
69              output bunches of debugging info
70
71       --version
72              show program's version number and exit
73
74

Standard bugzilla options

76       These options are shared by some combination of the 'new', 'query', and
77       'modify' sub commands. Not every option works for each command though.
78
79
80       --product=PRODUCT, -p PRODUCT
81              Product name
82
83       --version=VERSION, -v VERSION
84              Product version
85
86       --component=COMPONENT, -c COMPONENT
87              Component name
88
89       --summary=SUMMARY, -s SUMMARY, --short_desc=SUMMARY
90              Bug summary
91
92       --comment=DESCRIPTION, -l DESCRIPTION
93              Set initial bug comment/description
94
95       --comment-tag=TAG
96              Comment tag for the new comment
97
98       --sub-component=SUB_COMPONENT
99              RHBZ sub component name
100
101       --os=OS, -o OS
102              Operating system
103
104       --arch=ARCH
105              Arch this bug occurs on
106
107       --severity=SEVERITY, -x SEVERITY
108              Bug severity
109
110       --priority=PRIORITY, -z PRIORITY
111              Bug priority
112
113       --alias=ALIAS
114              Bug alias (name)
115
116       --status=STATUS, -s STATUS, --bug_status=STATUS
117              Bug status (NEW, ASSIGNED, etc.)
118
119       --url=URL, -u URL
120              URL for further bug info
121
122       --target_milestone=TARGET_MILESTONE, -m TARGET_MILESTONE
123              Target milestone
124
125       --target_release=TARGET_RELEASE
126              RHBZ Target release
127
128       --blocked=BUGID[, BUGID, ...]
129              Bug IDs that this bug blocks
130
131       --dependson=BUGID[, BUGID, ...]
132              Bug IDs that this bug depends on
133
134       --keywords=KEYWORD[, KEYWORD, ...]
135              Bug keywords
136
137       --groups=GROUP[, GROUP, ...]
138              Which user groups can view this bug
139
140       --cc=CC[, CC, ...]
141              CC list
142
143       --assigned_to=ASSIGNED_TO, -a ASSIGNED_TO, --assignee ASSIGNED_TO
144              Bug assignee
145
146       --qa_contact=QA_CONTACT, -q QA_CONTACT
147              QA contact
148
149       --flag=FLAG
150              Set or unset a flag. For example, to set a flag named devel_ack,
151              do  --flag  devel_ack+   Unset  a  flag with the 'X' value, like
152              --flag needinfoX
153
154       --tags=TAG
155              Set (personal) tags field
156
157       --whiteboard WHITEBOARD, -w WHITEBOARD, --status_whiteboard WHITEBOARD
158              Whiteboard field
159
160       --devel_whiteboard DEVEL_WHITEBOARD
161              RHBZ devel whiteboard field
162
163       --internal_whiteboard INTERNAL_WHITEBOARD
164              RHBZ internal whiteboard field
165
166       --qa_whiteboard QA_WHITEBOARD
167              RHBZ QA whiteboard field
168
169       --fixed_in FIXED_IN, -F FIXED_IN
170              RHBZ 'Fixed in version' field
171
172       --field=FIELD=VALUE
173              Manually specify a bugzilla XMLRPC field. FIELD is the raw  name
174              used  by  the  bugzilla  instance.  For example if your bugzilla
175              instance  has  a   custom   field   cf_my_field,   do:   --field
176              cf_my_field=VALUE
177
178
179

Output options

181       These  options  are  shared  by several commands, for tweaking the text
182       output of the command results.
183
184       --full, -f
185              output detailed bug info
186
187       --ids, -i
188              output only bug IDs
189
190       --extra, -e
191              output additional bug information (keywords, Whiteboards, etc.)
192
193       --oneline
194              one line summary of the bug (useful for scripts)
195
196       --raw  raw output of the bugzilla contents
197
198       --outputformat=OUTPUTFORMAT
199              Print output in the form given. You can use RPM-style tags  that
200              match bug fields, e.g.: '%{id}: %{summary}'.
201
202              The  output  of  the bugzilla tool should NEVER BE PARSED unless
203              you are using a custom --outputformat. For everything else, just
204              don't  parse  it,  the formats are not stable and are subject to
205              change.
206
207              --outputformat allows printing arbitrary bug data in a user pre‐
208              ferred  format.  For example, to print a returned bug ID, compo‐
209              nent, and product, separated with ::, do:
210
211              --outputformat "%{id}::%{component}::%{product}"
212
213              The fields (like 'id', 'component', etc.) are the names  of  the
214              values returned by bugzilla's XMLRPC interface. To see a list of
215              all fields, check the API documentation in the 'SEE  ALSO'  sec‐
216              tion. Alternatively, run a 'bugzilla --debug query ...' and look
217              at the key names returned in the query results.  Also,  in  most
218              cases,  using  the  name  of  the associated command line switch
219              should work, like --bug_status becomes %{bug_status}, etc.
220
221
222

‘query’ specific options

224       Certain options can accept a comma separated  list  to  query  multiple
225       values, including --status, --component, --product, --version, --id.
226
227       Note:  querying  via explicit command line options will only get you so
228       far. See the --from-url option for a way to use powerful Web UI queries
229       from the command line.
230
231       --id ID, -b ID, --bug_id ID
232              specify individual bugs by IDs, separated with commas
233
234       --reporter REPORTER, -r REPORTER
235              Email: search reporter email for given address
236
237       --quicksearch QUICKSEARCH
238              Search using bugzilla's quicksearch functionality.
239
240       --savedsearch SAVEDSEARCH
241              Name  of  a  bugzilla  saved search. If you don't own this saved
242              search, you must passed --savedsearch_sharer_id.
243
244       --savedsearch-sharer-id SAVEDSEARCH_SHARER_ID
245              Owner ID of the --savedsearch. You can get this ID from the  URL
246              bugzilla  generates  when  running the saved search from the web
247              UI.
248
249       --from-url WEB_QUERY_URL
250              Make a working query via bugzilla's 'Advanced  search'  web  UI,
251              grab  the  url  from  your browser (the string with query.cgi or
252              buglist.cgi in it), and --from-url will run it via the  bugzilla
253              API.  Don't  forget  to  quote  the  string! This only works for
254              Bugzilla 5 and Red Hat bugzilla
255
256
257

‘modify’ specific options

259       Fields that take multiple values have a special input format.
260
261        Append:    --cc=foo@example.com
262        Overwrite: --cc==foo@example.com
263        Remove:    --cc=-foo@example.com
264
265       Options  that  accept  this  format:  --cc,   --blocked,   --dependson,
266       --groups, --tags, whiteboard fields.
267
268       --close RESOLUTION, -k RESOLUTION
269              Close with the given resolution (WONTFIX, NOTABUG, etc.)
270
271       --dupeid ORIGINAL, -d ORIGINAL
272              ID of original bug. Implies --close DUPLICATE
273
274       --private
275              Mark new comment as private
276
277       --reset-assignee
278              Reset assignee to component default
279
280       --reset-qa-contact
281              Reset QA contact to component default
282
283
284

‘attach’ options

286       --file=FILENAME, -f FILENAME
287              File to attach, or filename for data provided on stdin
288
289       --description=DESCRIPTION, -d DESCRIPTION
290              A short description of the file being attached
291
292       --type=MIMETYPE, -t MIMETYPE
293              Mime-type for the file being attached
294
295       --get=ATTACHID, -g ATTACHID
296              Download the attachment with the given ID
297
298       --getall=BUGID, --get-all=BUGID
299              Download all attachments on the given bug
300
301       --comment=COMMENT, -l COMMENT
302              Add comment with attachment
303
304
305

‘info’ options

307       --products, -p
308              Get a list of products
309
310       --components=PRODUCT, -c PRODUCT
311              List the components in the given product
312
313       --component_owners=PRODUCT, -o PRODUCT
314              List components (and their owners)
315
316       --versions=PRODUCT, -v PRODUCT
317              List the versions for the given product
318
319       --active-components
320              Only show active components. Combine with --components*
321
322
323

AUTHENTICATION COOKIES AND TOKENS

325       Older  bugzilla  instances  use  cookie-based authentication, and newer
326       bugzilla instances (around 5.0) use a non-cookie token system.
327
328       When you log into bugzilla with the "login" subcommand or the "--login"
329       argument,  we  cache the login credentials in ~/.cache/python-bugzilla/
330       Previously we cached credentials in ~/.<filename>. If you want  to  see
331       which file the tool is using, check --debug output.
332
333       To  perform  an  authenticated bugzilla command on a new machine, run a
334       one time "bugzilla login"  to  cache  credentials  before  running  the
335       desired  command.  You  can  also  run "bugzilla --login" and the login
336       process will be initiated before invoking the command.
337
338       Additionally, the --no-cache-credentials option will tell the  bugzilla
339       tool  to  _not_  save  any  credentials in $HOME, or use any previously
340       cached credentials.
341
342

EXAMPLES

344       bugzilla query --bug_id 62037
345
346       bugzilla query --version 15 --component python-bugzilla
347
348       # All boolean options can be formatted like this
349       bugzilla query --blocked "123456 | 224466"
350
351       bugzilla login
352
353       bugzilla new -p Fedora -v rawhide -c python-bugzilla \
354                --summary "python-bugzilla causes headaches" \
355                --comment "python-bugzilla made my brain hurt when I used it."
356
357       bugzilla attach --file ~/Pictures/cam1.jpg --desc "me, in pain" $BUGID
358
359       bugzilla attach --getall $BUGID
360
361       bugzilla modify --close NOTABUG --comment "Actually, you're  hungover."
362       $BUGID
363
364
365

EXIT STATUS

367       bugzilla  normally  returns  0 if the requested command was successful.
368       Otherwise, exit status is 1 if bugzilla is interrupted by the user  (or
369       a login attempt fails), 2 if a socket error occurs (e.g. TCP connection
370       timeout), and 3 if the server returns an XML-RPC fault.
371

BUGS

373       Please report any bugs as github issues at
374       https://github.com/python-bugzilla/python-bugzilla
375       to the mailing list at
376       https://fedorahosted.org/mailman/listinfo/python-bugzilla
377

SEE ALSO

379       https://bugzilla.readthedocs.io/en/latest/api/index.html
380       https://bugzilla.redhat.com/docs/en/html/api/Bugzilla/WebService/Bug.html
381
382
383
384version 2.1.0                    Mar 30, 2017                      bugzilla(1)
Impressum