summaryrefslogtreecommitdiff
path: root/docs/japi.pod
blob: 70cc710ff7eea46eb5374f6966fc1cb85cd5d6ea (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
=head1 NAME

japi - A Humble Jira API Tool

This is a small and simple command line tool to be used manually or via cron to fetch the newest unresolved and unclosed tickets from a Jira project. 

It might be usefull to write the results every hour to a local file and do a C<cat ~/.issues> every time you open a new shell.

CAUTION: You may also need to install the C<JIRA::REST> module from CPAN manually. It's not included in standard Debian GNU/Linux Wheezy yet.

=head1 SYNOPSIS

Synopsis: japi
  [--debug]
  [--help]
  [--version]
  [--passfile]
  [--jira_apiversion STRING]
  [--jira_query STRING]
  [--jira_uribase STRING]
  [--jira_user STRING]

=head2 Options:

=over 

=item --debug

Prints out extra debugging infos during execution. 

=item --help

Prints out the help.

=item --version

Prints out the version.

=item --passfile STRING

Specifies the path to an optional file which includes the Jira API password but Base64 encoded. The default value is C<~/.japipass>.

If the file is not present, Japi will prompt for the password. 

=item --jira_apiversion STRING

Specifies the Jira API version to use. The default value is C<rest/api/2>.

=item --jira_query STRING

Specifies the Jira search string (e.q. a JQL string). The default value is C<search?jql=project=MT and status not in (Resolved,Closed)>.

=item --jira_uribase STRING

Specifies the Jira URI base. The default value is C<https://your-jira.example.com>. This has to be changed.

=item --jira_user STRING

Specifies the Jira user. The default value is your current Linux/UNIX user.

=back

=head1 CONFIG

Almost all options have to be passed the Japi tool via command line. One exception is the password file containing your Jira password Base64 encoded.

It can be created like this:

  bash -c 'read -s PASSWORD; tr -d "\n" <<< "$PASSWORD" | base64' | tee ~/.japipass

=head1 AUTHOR

Paul C. Buetow - <paul@buetow.org>

=cut