Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


This article is to give the step by step instructions on how to install the Jira CLI and execute CLI commands in Windows with CLI client version 9.0 and above.

...

  1. You need to download the latest client version from this page. For example, you can click on the atlassian-cli-9.1.0-distribution.zip to download the latest client version v9.1.0. (which is the latest at the time of writing this document).
  2. Once the file is downloaded, extract the files. For example, you can right-click on the downloaded file and click on Extract Files... 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. You would need to update  Update the acli.properties file with the required parameters like server name, and credentials. For example, the Jira CLI file looks something similar to thisas per the below instructions:

    1. Credentials with respect to your instance details where you want to execute the CLI actions.

      Code Block
      languageactionscript3
      themeMidnight
      credentials       = --user automation --password automation


    2. If you want to execute the CLI action for confluence, then commentmyjiraoption and give the Confluence URL detail of your instance.

      Code Block
      languageactionscript3
      themeMidnight
      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.

      Code Block
      languageactionscript3
      themeMidnight
      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. Ensure 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.

...