@andyasberry/jira-git-cli

jira-git-cli

A CLI to supercharge :zap: operations between Jira and Git, such as injecting the jira key into your branch name :rocket:.

jg: It's Your Toolset. You Want It Now.

Prerequisites

Node

Node.js >= 12

Environment variables:

Environment variables used by the jira-git-cli are prefixed with JG_.

JG_JIRA_API_TOKEN='<your_jira_api_token>'

Usage

First things first: set up the environment variables listed in the Prerequisites.

Next, run init, and follow prompts:

jg init

:spiral_notepad: This tool interfaces with the Jira REST API, and requires an internet connection to function.

Create a git branch using jira issues assigned to you:

jg br

:spiral_notepad: Fetches all issues assigned to you in Jira that are in "Working" status. The default is the most recently updated issue, but you can select another from a menu.

:bulb: Use the help command to see more options, such as filtering by project(s)!

Move the status of the Jira Issue you're working on:

jg mv 'In QA'

:spiral_notepad: The jira key is extracted from the branch name.

Help and more...

For more commands and information, seek help.

jg help

Local Development

Trying to keep it simple here...

# 1. Install dependencies
yarn
# 2. Make some changes in the /src folder
...
# 3. Run the tests
yarn test
# 4. Build the output
yarn build
# 5. Commit changes
...

Happy hacking! :nerd_face: