JIT: JIRA Issue Tool

A simple Rust CLI tool to extract ticket ID and summary information from JIRA issues using the JIRA API.

Installation

cargo install jit-cli

This installs the jit command.

Usage

Standard output

# Using a ticket ID
jit ISSUE-123

# Using a JIRA URL
jit https://your-company.atlassian.net/browse/ISSUE-123

Example output:

Ticket:   ISSUE-123
Summary:  Fix the login button in Safari

Text output (compact format)

jit --text ISSUE-123

Example output:

ISSUE-123: Fix the login button in Safari

JSON output

# Using a ticket ID
jit --json ISSUE-123

# Using a JIRA URL
jit --json https://your-company.atlassian.net/browse/ISSUE-123

Example output:

{"ticket":"ISSUE-123","summary":"Fix the login button in Safari"}

Detailed Information (Table)

View detailed information about a ticket in a well-formatted table:

# Using a ticket ID
jit --show ISSUE-123

# Using a JIRA URL
jit --show https://your-company.atlassian.net/browse/ISSUE-123

Example output:

TICKET DETAILS

ISSUE-123: Fix the login button in Safari

Type:       Bug                  Priority:   Medium
Status:     In Progress          Sprint:     Development Sprint 27
Assignee:   John Doe             Reporter:   Jane Smith
Created:    2023-09-15           Updated:    2023-09-16
Due Date:   2023-09-30

DESCRIPTION

The login button doesn't work properly in Safari browsers.
Steps to reproduce:
1. Open the login page in Safari
2. Click on the login button
3. Nothing happens

Expected: The login form should be submitted.
Actual: Nothing happens when the button is clicked.

Current Sprint Tickets

View your tickets in the current active sprint:

# View all your tickets in the current sprint
jit --my-tickets

# Limit the number of tickets shown
jit --my-tickets --limit 5

Example output:

Current Sprint: Development Sprint 27

+-----------+----------------------------------+-------------------+
| Key       | Summary                          | Status            |
+-----------+----------------------------------+-------------------+
| PROJ-123  | Implement new login page         | In Review         |
+-----------+----------------------------------+-------------------+
| PROJ-124  | Fix responsiveness on dashboard  | In Progress       |
+-----------+----------------------------------+-------------------+
| PROJ-125  | Update API documentation         | Done              |
+-----------+----------------------------------+-------------------+

Configuration

The tool looks for JIRA credentials in the following locations (in order):

1. Custom environment file specified with --env-file option
2. .env file in the current directory
3. .env file in ~/.config/jit/ directory
4. Environment variables set in your shell

When running for the first time, create a .env file in your home directory at ~/.config/jit/.env with:

JIRA_BASE_URL=https://your-company.atlassian.net
JIRA_API_TOKEN=your_api_token_here
JIRA_USER_EMAIL=your_email@example.com

With this configuration, you can run the tool from any directory on your system.

Setup

1. Clone the repository
2. Create a .env file in the root directory with the following variables:

   JIRA_BASE_URL=https://your-company.atlassian.net
   JIRA_API_TOKEN=your_api_token_here
   JIRA_USER_EMAIL=your_email@example.com
   

3. Get a JIRA API token from Atlassian's API tokens page
4. Run cargo build --release

API Token Creation

1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
2. Click "Create API token"
3. Give it a name like "JIRA Title CLI"
4. Copy the token and save it in your .env file