CLI Client Installation and Use - Version 8.x

On this page

Obsolete

This ONLY applies to versions 8.x and lower. New configuration support is available in Version 9.0 and higher that eliminates the complexity of this start script.


Starting with ACLI Release 9.2, it is recommended installation is done using platform installers available from Downloads.
This page covers installation instructions for advanced users wanting to install directly from a zip distribution.


Summary

The Atlassian CLI client is a zip distribution that needs to be unpacked and installed on a supporting client system (Windows, Linux, OSX) running Java 8 or Java 11 (preferred).

Installation is simple and should only take a few minutes. Optional configuration can make usage easier to connect to your Atlassian servers and our recipes assume you've performed these. All application specific clients are included in the single Atlassian CLI distribution.

To use a CLI client, you will need to run commands from a  command prompt window (Windows) or a terminal window (Linux, OSX). 

Atlassian CLI Slide Shows - Introduction and detailed slide presentations to help you get started.

Know your server's URL

You will need to know the server's access URL to set the server parameter. Normally the same as you use for accessing from a browser. That may include a context like /wiki or similar depending on how your server was installed. Some Cloud clients (like Bitbucket Cloud, Slack, Trello) do not have a server parameter.

Server examples:

  • Jira - https://jira.examplegear.com
  • Confluence - https://confluence.examplegear.com

Cloud Users

Always keep your client current with the latest release. Atlassian updates the Cloud platform almost daily and these changes sometimes cause things to break. If you experience the symptom: worked yesterday and fails today. Then follow these steps:

  1. Make sure you are on the latest release of the CLI client and try again.
  2. Still broken? Then try the latest CLI SNAPSHOT release. We ship releases daily if necessary to fix issues especially Cloud related.
  3. Still broken? Report it to us immediately. We will investigate and likely provide a SNAPSHOT fix to keep you running successfully.

Steps

Common Problems

  1. Errors in your bat or sh file.
  2. Remote error: User is not authorized to perform the request. Response code: 401. Incorrect user id or password.
    • Cloud users MUST use their email address 
    • Cloud users MUST use a Atlassian Id API token for their password or token parameters - Atlassian Personal Access Tokens
  3. Remote error: Action disallowed. Response code: 403 (click for the answer).
  4. SSL issues (click for answers).