Jira CLI

 

Example Workflow to Create a Jira Ticket Using Jira CLI

To create a Jira ticket using the Jira CLI, you can use the jira-cli tool, which is a feature-rich command-line interface for interacting with Jira. Below is an example workflow:

Step 1: Install Jira CLI

First, ensure you have the jira-cli tool installed. You can install it using npm:

bash

npm install -g jira-cli

Step 2: Configure Jira CLI

Set up the Jira CLI by providing your Jira instance URL, email, and API token. Run the following command:

bash

jira configure

You will be prompted to enter:

Jira Base URL (e.g., https://yourcompany.atlassian.net)

Email address

API token (you can generate this from your Jira account settings).

Step 3: Create a Jira Ticket

Once configured, you can create a Jira ticket using the jira issue create command. Here's an example:

bash

jira issue create \

  --project "PROJECT_KEY" \

  --type "Task" \

  --summary "This is a sample ticket summary" \

  --description "Detailed description of the issue or task."

Replace PROJECT_KEY with the key of your Jira project (e.g., DEV, IT, etc.).

Replace "Task" with the issue type (e.g., Bug, Story, etc.).

Provide a meaningful summary and description for the ticket.

Step 4: Automate Ticket Creation (Optional)

You can integrate this command into a script or CI/CD pipeline (e.g., GitHub Actions) to automate ticket creation. For example, in a shell script:

bash

#!/bin/bash

jira issue create \

  --project "PROJECT_KEY" \

  --type "Bug" \

  --summary "Automated Bug Report" \

  --description "This bug was automatically reported by the CI/CD pipeline."

This script can be triggered whenever a specific event occurs, such as a failed build or test.

Additional Features

The jira-cli tool also supports other features like:

Transitioning tickets between statuses.

Adding comments to tickets.

Searching for issues.

For more advanced workflows, refer to the official documentation of  Jira Command Line Interface (CLI) | Atlassian Marketplace

More details: GitHub - ankitpokhrel/jira-cli: 🔥 Feature-rich interactive Jira command line.

Create issue based on template:

# Load description from template file

$ jira issue create --template /path/to/template.tmpl

# Get description from standard input

$ jira issue create --template -

# Or, use pipe to read input directly from standard input

$ echo "Description from stdin" | jira issue create -s"Summary" -tTask