aboutsummaryrefslogtreecommitdiffstats
path: root/doc/wajir.1.txt
blob: 6cc6f888c8ba50dfc284537e3eff24a5c594473b (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
48
49
50
51
52
53
54
55
56
57
58
59
wajir(1)
========

NAME
----
wajir - Watch Jira issues

SYNOPSIS
--------
[verse]
'wajir' [--login <login>] [--token <token>] [--endpoint <endpoint>]
	[--sendmail <command>] [--email-to <address>] [-v | --verbose]
	[-h | --help] [-V | --version] <JQL>

DESCRIPTION
-----------
Automatically watch Jira issues. Given a JQL query, the currently authenticated
user will be added as a watcher on all resulting issues.

For example, this JQL query finds all issues in the project "FAKE" that are not
watched by the current user:

	project = "FAKE" AND watcher != currentUser() ORDER BY created ASC

Passing the above JQL to Wajir will cause the current user to watch all
unwatched issues in the "FAKE" project.

If the *--sendmail* and *--email-to* options are provided, an email containing
the issue summary, description, and a few other metadata fields will be sent
using the program given in *--sendmail* to the *--email-to* address.

OPTIONS
-------
--login::
	Jira login email address.

--token::
	Jira API token. Obtained from:
	https://id.atlassian.com/manage-profile/security/api-tokens

--endpoint::
	The team-specific Atlassian host (e.g. *example.atlassian.net*).

--sendmail::
	The command named in this argument will be exec'ed and given an email on its
	standard input. This will typically be a Mail Transfer Agent or Mail
	Delivery Agent. If set, the *--email-to* option must also be set.

--email-to::
	Recipient email address that `issue created' emails will be sent to.

-v, --verbose::
	Turn on verbose output.

-h, --help::
	Print usage help.

-V, --version::
	Print the program version.