shawncatz / jira

basic Jira CLI

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Jira CLI

Basic golang-based Jira CLI. Allows you to create, show, and browse to issues

Browse

This will open the link to the ticket with your default browser (using open on macOS)

jira browse TICKET-1234

opening: https://anyperk.atlassian.net/browse/TICKET-1234

Create

jira create

? Project for issue? TICKET
? Choose an issue type: Bug
? Choose a sprint: Backlog
? Title for issue? Title of issue
? Please enter a description [Enter to launch editor]

Some of the fields allow you to select from a list (thanks to AlecAivazis/survey):

? Choose an issue type:  [Use arrows to move, type to filter]
❯ Bug
  Task
  Story

Show

Get a quick summary of a ticket.

jira show TICKET-1234

TICKET-1234    : Title of issue
Type           : Bug
Priority       : Blocker
Assigned       : person
Description    :
Something was borked

person2 (person2@email.com)
Fixed!

person3 (person3@email.com)
Link to document
https://docs.google.com/document/d/...

https://yourcompany.atlassian.net/browse/TICKET-1234

Init

Creates a default configuration file

jira init

Report

Generate reports. Currently supports sprint report only.

jira report

Sprint

Manage sprints in Jira. For now, just list sprints.

jira sprint

Update

Updates the configuration file with values from Jira (board, sprints)

jira update

Setup

Use the jira init command to create a configuration file in $HOME/.jira.yaml

base: <base URL>
user: <email>
pass: <api key>
project: PROJECT
board: # This will be populated by running 'jira update'
types: # First in the list is default, must have at least one
  - Bug
  - Task
  - Story
sprints: # This will be populated by running 'jira update'
  • base URL: The URL to your Atlassian Cloud JIRA account (https://yourname.atlassian.net)
  • email: The email of your account
  • api key: Your Atlassian API token, see here for more info

Installation

The easiest and recommended way to setup the tool is to download a prebuilt release from Github.

Move the file into your ~/bin directory and reset the permissions:

mkdir -p ~/bin mv ~/Download/jira-darwin-amd64- ~/bin/jira chmod 0755 ~/bin/jira

Install from source

If you have the go toolchain configured on your computer, you can install the tool with the following command:

go get github.com/shawncatz/jira

You can update the installed version with:

go get -u github.com/shawncatz/jira

Thanks

About

basic Jira CLI

License:Apache License 2.0


Languages

Language:Go 95.3%Language:Makefile 4.7%