diff options
| -rw-r--r-- | README.pod | 86 | ||||
| -rw-r--r-- | README.txt | 72 |
2 files changed, 72 insertions, 86 deletions
diff --git a/README.pod b/README.pod deleted file mode 100644 index 8a080af..0000000 --- a/README.pod +++ /dev/null @@ -1,86 +0,0 @@ -=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] - [--nocolor] - [--passfile] - [--unassigned] - [--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 --nocolor - -By default the output uses colored text output. This switch disables it. - -=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 --unassigned - -By default the output lists assigned and unassigned issues. Use this switch to only list unassigned issues. - -=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 - chmod 0600 ~/.japipass - -=head1 AUTHOR - -Paul C. Buetow - <paul@buetow.org> - -=cut diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..7b1043b --- /dev/null +++ b/README.txt @@ -0,0 +1,72 @@ +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 "cat ~/.issues" every time you open a new shell. + + CAUTION: You may also need to install the "JIRA::REST" module from CPAN + manually. It's not included in standard Debian GNU/Linux Wheezy yet. + +SYNOPSIS + Synopsis: japi [--debug] [--help] [--version] [--nocolor] [--passfile] + [--unassigned] [--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. + + --nocolor + By default the output uses colored text output. This switch disables + it. + + --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. + + --unassigned + By default the output lists assigned and unassigned issues. Use this + switch to only list unassigned issues. + + --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 + chmod 0600 ~/.japipass + +AUTHOR + Paul C. Buetow - <paul@buetow.org> + |