A command line tool that makes easy to show issue list from Jira

by iOS Example

Command Utility JIRA

cujira is a command line tool that makes easy to show issue list from Jira.

Installation

Clone this repository and run install.sh.

$ git clone https://github.com/cats-oss/cujira.git
$ cd cujira
$ ./install.sh

Usage

1. Register domain, username and apikey.

Please execute those 3 commands.

$ cujira register domain XXX

$ cujira register username XXX

$ cujira register apikey XXX

In addition, you can check registered information with cujira register info.

2. Check ProjectID (or BoardID) and Add Project Alias.

You can check ProjectID (or BoardID) with cujira list board that shown all boards of your Jira domain.

$ cujira list board

Results:

	id: 1
	name: cujira Development
	project - id: 10001
	project - name: cujira

	id: 2
	name: cujira Bug Fix
	project - id: 10002
	project - name: cujira (Bug)

After checking ProjectID, add Project alias with cujira alias project add.

$ cujira alias project add cujira-bug --project-id 10002

In addition, you can check registered project alias with cujira alias project list.

$ cujira alias project list

    name: cujira-bug, projectID: 10002, boardID: 2

3. Get project issues with today, yyyy/mm/dd or SPRINT_NAME.

If you want to get today's issues of project, below command can show them.

$ cujira issue search cujira-bug today
JQL: project = 10002 AND created >= startOfDay()

Summary: All command responses are `Great Scott!!`.
URL: https://XXX.atlassian.net/browse/BUG-1985
IssueType: Critical Bug
Status: Open
User: doc-emmett-brown

Summary: Command usages is a little strange.
URL: https://XXX.atlassian.net/browse/BUG-1986
IssueType: Bug
Status: Open
User: --

If you want to get issues with SPRINT_NAME, check sprints with cujira list sprint.

$ cujira list sprint --alias cujira-bug

Results:

	id: 5
	name: Sprint 1
	startDate: 2018/06/02
	endDate: 2018/06/07

	id: 8
	name: Sprint 2
	startDate: 2018/06/08
	endDate: --

After checking sprint name, you can get issues with cujira issue search cujira-bug "Sprint 2".

Additional Usage for getting Issues.

cujira issue search has some options.

Options:

    --issus-type [ISSUE_TYPE]
        ... Filter issues with a issueType.
    --label [ISSUE_LABEL]
        ... Filter issues with a issue label.
    --status [STATUS_NAME]
        ... Filter issues with a issue status.
    --assigned [USER_NAME]
        ... Filter issues with a user who has assigned.
    --epic-link [EPIC_LINK]
        ... Filter issues with a epic link.
    --aggregate
        ... Show every options issue counts.
    --all-issues
        ... Print all issues to ignore options. (This option is only available to use `--aggreegate`)
    --output-json
        ... Print results as JSON format.

You can get aggregation of issues.

$ cujira issue search cujira-bug today --issue-type "Critical Bug" --aggregate
JQL: project = 10002 AND created >= startOfDay()

Summary: All command responses are `Great Scott!!`.
URL: https://XXX.atlassian.net/browse/BUG-1985
IssueType: Critical Bug
Status: Open
User: doc-emmett-brown

Number of Issues: 2
Number of Critical Bug: 1

Combination Usage with other scripts.

cujira issue search command has --output-json option.
It makes easily to handle cujira response in other scripts.
This is node.js sample code.

// sample.js
var exec = require('child_process').exec;

var COMMAND = 'cujira issue search cujira-bug today --issue-type \"Critical Bug\" --aggregate --output-json';

exec(COMMAND, function(error, stdout, stderr) {
    var aggregations = JSON.parse(stdout);

    aggregations.forEach(aggregation => {
        console.log('name: ' + aggregation.name);
        console.log('count: ' + aggregation.count);
        aggregation.issueResults.forEach(issueResult => {
            console.log('\tid: ' + issueResult.issue.id);
        });
    });
});

$ node sample.js
name: Issues
count: 2
  id 19851026
  id 20151021
name: Critical Bug
count: 1
	id 19851026
name: Matched Issues
count: 1
	id 19851026

Environment Variables

You can run cujira with environment variables.

$ env CUJIRA_USER_NAME="XXX" CUJIRA_API_KEY="XXX" CUJIRA_DOMAIN="XXX" cujira

Development

  • Xcode 9.2 or greater
  • Swift 4.0.3 or greater

GitHub