blob: 5d82cb4d1f2d489de15801cd1950417300aa8c4a (
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
'\" t
.\" Title: wajir
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 05/11/2022
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "WAJIR" "1" "05/11/2022" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
wajir \- Watch Jira issues
.SH "SYNOPSIS"
.sp
.nf
\fIwajir\fR [\-\-login <login>] [\-\-token <token>] [\-\-endpoint <endpoint>]
[\-\-sendmail <command>] [\-\-email\-to <address>] [\-v | \-\-verbose]
[\-h | \-\-help] [\-V | \-\-version] <JQL>
.fi
.SH "DESCRIPTION"
.sp
Automatically watch Jira issues\&. Given a JQL query, the currently authenticated user will be added as a watcher on all resulting issues\&.
.sp
For example, this JQL query finds all issues in the project "FAKE" that are not watched by the current user:
.sp
.if n \{\
.RS 4
.\}
.nf
project = "FAKE" AND watcher != currentUser() ORDER BY created ASC
.fi
.if n \{\
.RE
.\}
.sp
Passing the above JQL to Wajir will cause the current user to watch all unwatched issues in the "FAKE" project\&.
.sp
If the \fB\-\-sendmail\fR and \fB\-\-email\-to\fR options are provided, an email containing the issue summary, description, and a few other metadata fields will be sent using the program given in \fB\-\-sendmail\fR to the \fB\-\-email\-to\fR address\&.
.SH "OPTIONS"
.PP
\-\-login
.RS 4
Jira login email address\&.
.RE
.PP
\-\-token
.RS 4
Jira API token\&. Obtained from:
https://id\&.atlassian\&.com/manage\-profile/security/api\-tokens
.RE
.PP
\-\-endpoint
.RS 4
The team\-specific Atlassian host (e\&.g\&.
\fBexample\&.atlassian\&.net\fR)\&.
.RE
.PP
\-\-sendmail
.RS 4
The command named in this argument will be exec\(cqed and given an email on its standard input\&. This will typically be a Mail Transfer Agent or Mail Delivery Agent\&. If set, the
\fB\-\-email\-to\fR
option must also be set\&.
.RE
.PP
\-\-email\-to
.RS 4
Recipient email address that \(oqissue created\(cq emails will be sent to\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Turn on verbose output\&.
.RE
.PP
\-h, \-\-help
.RS 4
Print usage help\&.
.RE
.PP
\-V, \-\-version
.RS 4
Print the program version\&.
.RE
|
