Versions Compared

Old Version 15

changes.mady.by.user Avinash Bhagawati

Saved on

compared with

New Version Current

changes.mady.by.user Smita Nair

Saved on

Key

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

Overview

Excerpt

This article provides answers to the most frequently asked questions on the CLI app.

...

FAQs


Expand
titleWhere exactly does this app run?

Jira/Confluence/Bamboo/Bitbucket/Atlassian Command Line Interface (CLI) has 2 components:

  1. CLI Connector - This is installed on the server using UPM and  Universal Plug-in Manager (UPM) and provides a specific license validation REST API.   It is accessible to CLI client via <base-url>/rest/org.swift.confluence.cli/latest/validatelicense.
  2. CLI Client - This is can be installed on any operating system (Windows, Linux, OSX) that has Java 8 or higher. The CLI client runs on this system.
CLI client can be downloaded

Download the CLI Client from Downloads - CLI Clients to the  on the local machine where actions can be run from. Please see you want to execute the actions. See the page What is the difference between CLI clients and Run CLI add-ons? for more information.


Expand
titleDo clients still require an instance add-on app (CLI Connector) be installed?

Yes (with , with some exceptions). This has not changed. The Connector add-on app provides license enforcement, and, in some cases, extended remote interfaces are not available from the base Atlassian product.

A few The following clients are provided at no charge and do not require a connector. They include:


Expand
titleCan clients CLI Clients be purchased separately?

No.  This has not changed. CLI Clients are available for at no - charge with the purchase of one or more of server or cloud add-onsapps. 


How is it accessing Atlassian application
Expand
titleWhat does an existing Run CLI Actions add-on app customer need to do to remain properly licensed ?
title

Nothing, if they do not use clients CLI Clients and only use the integrated support as part of their Atlassian product. Renew your license as normal usual when maintenance has expired.

If you want to use clients CLI Clients as well as the integrated capabilities, then a an additional CLI license will be needed is required for the CLI Connector. This license change was effective infrom CLI version 6.x but was enforced only enforced when you upgrade your clients when upgrading Clients to 7.0 or higher. You If you are entitled to a discounted license (determined on your as per maintenance expiry date) - , contact us at operations@appfire.com when needed.

Expand

license@appfire.com.


Expand
titleHow can I evaluate the CLI app prior to purchase?

Obtain an evaluation license for one of the Atlassian apps listed, install the app, and then, download the ACLI Client distribution. See CLI Client Installation and Use for more information.


Expand
titleCan an ACL Client be used to access an instance that does not have the Connector app installed?

No. ACLI Client is not licensed to be used to access an Atlassian app or instance that requires a Connector app to be installed.


Expand
titleCan I continue to use a version of ACLI Client prior to version 7 ?

Yes. Versions prior to 7.0 can be used under the terms in effect at that time. Links are available in the Related Information section.


Expand
titleDo I need to purchase both the CLI and Run CLI Action apps to use both the client and the product specific functions ?

Yes. You must purchase both the CLI and Run CLI Action apps to use both the client and the product specific functions.


Expand
titleIf I am an official Atlassian Partner or Expert, can I get a special rate for CLI app?

Yes. Atlassian recognised partners and members of the Atlassian Experts Program can use any CLI app free of charge for development, testing, or, demonstration purposes. A commercial license is required when used to provide services to customers. See Add-ons for Atlassian Experts for more details.


Expand
titleAre CLI apps available for Atlassian Cloud ?

Yes. CLI apps for Jira, Jira Service Desk, Confluence Cloud etc., are available in Atlassian Cloud for purchase or trial subscription. Bitbucket Cloud is also supported by the ACLI Client and is currently available for a limited time at no charge.


Expand
titleDo I need a CLI license for an Atlassian server that is a developer/test system ?

No, for all servers except Crucible/FishEye.

  1. Any Atlassian paid app automatically provides a developer license associated with your production license. Go to my.atlassian.com, expand the app, and, look for a link.
  2. We have purposefully allowed CLI to work with developer servers where the connector is installed but do not have a license. This is to make it easier for administrators and add-on developers.
  3. Unfortunately, we are unable to provide same support for Crucible/FishEye at this time due to limitations in determining a developer licensed server.


Expand
titleHow many client users can I have ?

Unlimited. Any number of users can install clients and connect to a server. The requirement is that the host must have the CLI Connector component installed with valid license.


Expand
titleWhich server product should I choose ?

Choose the product specific Command Line Interface (CLI Connector) if you want to use a client to connect to the Atlassian product.

Choose the product specific Run CLI Actions app for integrated capabilities like JIRA workflow actions, Confluence macros, Bamboo tasks, or similar product capabilities available with these apps.


Expand
title Where do I find a CLI Connector on the Marketplace ?

Each of the following product specific Command Line Interface (CLI) Marketplace entries represent respective CLI Connectors (UPM installable). The links are provided as under:

The following clients do not need a connector:


Expand
titleWhere do I find CLI Client on the Marketplace ?

Atlassian Command Line Interface (CLI) provides a client distribution that contains all product specific clients. It is included at no charge with any of the CLI Connectors.


Expand
titleHow does CLI Client access Atlassian applications ?

The CLI client uses request/response protocol built on REST API calls provided by Atlassian to perform . It performs remote actions against your Confluence and Jira instanceAtlassian applications.


Expand
titleWhat permissions does it CLI Client require ?

Nothing specific to the app. The user's users standard Atlassian application permissions to determine what the user can or cannot do, just like any other instance access via REST APIs or the user interface.
Just like Confluence REST APIs, the user through which you are executing the action needs to have the required permission to access the instance and perform the requested action. Our app honors the permissions provided by Confluence the host app, and, if the user does not have specific permission, the user will is not be allowed to perform the action using Confluence CLI app as wellclient.


Expand
titleHow the CLI authenticates to application is a CLI Client user authenticated ?

The CLI Client authentication is different between cloud for Cloud and server Server versions of Confluence. For serverServer, authentication is based on the username and password provided when running the command from the CLI client Client or distribution. For cloud, an API token is required For Cloud, authentication is based on the username as email ID and password as API token. For additional information on authentication, seerefer to this document.


Expand
titleAre there any risks , in using this the CLI app ?

The risks in using this app are no different than from performing the same operations via the Atlassian app's application user interface. The CLI has only the just those capabilities that the Atlassian provided API offers. That said, as with any automation tool, we encourage our customers to carefully test their automation CLI actions in test environments whenever possible. We also suggest using the simulate option the simulate option, to understand in detail what a given command does, before using it in a live environment.


Expand
titleCan this app be misused beyond the Confluence application permission of the given to users ?

No. The CLI can perform only perform those operations that the user operating the CLI can do are permitted to be executed via the Atlassian appapplication's user interface. So, while it cannot be misused, it is very powerful and so should ; thus, must be used with care caution and after thorough testing as discussed above.


Expand
titleWhat can be done , if the above happens ?

The recourse or rollback options are identical to those in the UIuser interface. Some options to consider are making backups on of data about to be changed or that is expected to change, or, making a plan to revert the changes if needed via the CLI. For example, if using the CLI is used to create new users in bulk, one should have a CLI command must be ready to be used to remove or disable those users, if the results are unexpected.


Expand
titleWhat do customers like in this app ?

Our customers use the CLI to automate tedious and repetitive tasks so that they can spend their time on more valuable productive work. Many hours are saved daily by our customersOur customers daily save many work hours with this app. Some operations in the Atlassian user interface User Interface, that require many clicks and many screens, can be performed in single commandsusing minimal commands with this app.


Expand
titleHow easy is Is this app easy to learn ?

The CLI is a very powerful tool with . For example, it has over 200 actions available for Confluence. This can sometimes be a challenging learning curve until till one understands the consistent patterns to the in commands. Once that is understood well, then creating commands it becomes steadily easier to create CLI commands.


Expand
titleWhat are the support platforms are available for the CLI app ?

Our The Appfire support team actively monitors the Atlassian Community and our own CLI Questions forum in order to guide new users. We respond quickly and thoroughly to all support questions as well.

Expand
titleWe are setting up a few functional and performance test cases. Do you have any to test ?

Check our below How To section of the Atlassian application CLI documentation for numerous examples of complex and high-volume operations that you may use as test cases.

How To articles for Confluence Command Line Interface

How To articles for Jira Command Line Interface

How To articles for Bamboo Command Line Interface

How To articles for Bitbucket Command Line Interface