summaryrefslogtreecommitdiff
path: root/docs/japi.txt
blob: 9096b4662bc0ef02891d36379488146292c00a65 (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
NAME
    japi - A Humble Jira API Tool

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

  Options:
    --debug
        Prints out extra debugging infos during execution.

    --help
        Prints out the help.

    --version
        Prints out the version.

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

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

    --jira_apiversion <STRING>
        Specifies the Jira API version to use. The default value is
        "rest/api/2".

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

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

    --jira_user <STRING>
        Specifies the Jira user. The default value is your current
        Linux/UNIX user.

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

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