How to set up CLI client v9.0 and above in Windows and run CLI commands

This article gives step by step instructions on how to install the Jira CLI app and execute CLI commands in Windows using the CLI client version 9.0 and above.

Instructions

CLI is a command-line interface to access Jira remotely. CLI has two components:

• CLI Client - Installed on any Windows system that has Java version 8 or higher.
• CLI Connector - Installed on the server using Universal Plugin Manager (UPM).

JIRA CLI Client Installation:

1. You need to download the latest client version. For example, you can click on the atlassian-cli-9.1.0-distribution.zip to download the latest client version v9.1.0. (at the time of writing).
2. Once the file is downloaded, extract the files. For example, you can right-click on the downloaded file and click on Extract All... as shown in the below screenshot. Here, we have used the 7-Zip software.
   
3. Go to the ACLI folder (Ex: atlassian-cli-9.1.0)
4. Rename the acli-server file to acli as shown in the below screenshot.
   

5.  Update the acli.properties file as per the below instructions:

   1. Credentials of the instance where you want to execute the CLI actions. Here we have used automation/automation as credentials.
      

      credentials       = --user automation --password automation

      
      

   2. If you want to execute the CLI action for Jira, comment the myconfluence option or add the confluence details, if any.  
      

      myjira            = jira -s https://jira.examplegear.com ${credentials}
      #myconfluence      = confluence -s https://confluence.examplegear.com ${credentials}

   3. This defines the default client for actions, choose either Jira / Confluence based on where you want to execute CLI actions.
      

      default           = ${myjira}

   4.  Save file.

JIRA CLI Connector Installation:

1. Log into Jira as an administrator and click  >  Add-ons →  Find new apps and search for "Jira Command Line Interface". Upon receiving the results, click Free trial under the JIRA Command Line Interface (CLI).
   
2. After installation, ensure that the license is updated in the License section.
3. The CLI connector will be installed and you can view the app in the Manage apps page.

Executing the CLI Commands:

1. CLI commands are executed from the Windows command prompt. Open the command prompt and go to the path where the CLI client is installed. 

2. Here are some sample CLI commands:

   1. To create a project, use createProject action along with the required parameters. The below CLI command creates a project with a lead assigned:

      acli myjira --action createProject --project "DEVPROJECT" --lead "user1" --continue
      
      project 'DEVPROJECT' created with key DEVPROJECT and id 10200

   2.  To create an issue, use createIssue action along with the required and optional parameters. Below CLI command creates an issue with issue type and summary in a specific project (DEVPROJECT in the given example):

      acli myjira --action createIssue  --project "DEVPROJECT" --type "bug"  --summary "this is my new dev page"
      Issue DEVPROJECT-1 created with id 10104

   3. To add a comment to an issue, use addComment action along with the required and optional parameters. Below CLI command adds a comment to a particular issue (DEVPROJECT-1 is the issue key in the given example).

      acli myjira --action addComment --issue "DEVPROJECT-1" --comment "my new comment"
      Comment with id 10100 added to DEVPROJECT-1