Overview
Excerpt |
---|
This article provides answers to the most frequently asked questions on the CLI app. |
...
Expand | ||
---|---|---|
| ||
Jira/Confluence/Bamboo/Bitbucket/Atlassian Command Line Interface (CLI) has 2 components:
Download the CLI Client can be downloaded from Downloads - CLI Clients to the on the local machine where actions are run fromyou want to execute the actions. See the page What is the difference between CLI clients and Run CLI add-ons? for more information. |
Expand | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
No. CLI Clients are available for at no - charge with the purchase of one or more of server or cloud add-onsapps. |
Expand | ||
---|---|---|
| ||
Nothing, if they do not use CLI Clients and only use the integrated support as part of their Atlassian product. Renew your license as usual when maintenance has expired. If you want to use CLI Clients as well as the integrated capabilities, then an additional license is needed required for the CLI Connector. This license change was effective from CLI version 6.x but was enforced only enforced when upgrading Clients to 7.0 or higher. If you are entitled to a discounted license (determined as per maintenance expiry date), contact us at license@appfire.com. |
Expand | ||
---|---|---|
| ||
Obtain an evaluation license for one of the server app Atlassian apps listed, install on serverthe app, and then, download the ACLI Client distribution. See CLI Client Installation and Use for more information. |
Expand | ||
---|---|---|
| ||
No. ACLI Client cannot is not licensed to be used to access the server that does not have connector app an Atlassian app or instance that requires a Connector app to be installed. |
Expand | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
Yes. You need to must purchase both the CLI and Run CLI Action apps to use both the client and the product specific functions. |
...
Expand | ||
---|---|---|
| ||
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 support hosted customers. See Add-ons for Atlassian Experts for more details. |
Expand | ||
---|---|---|
| ||
Yes. CLI apps for Jira, Jira Service Desk, Confluence Cloud , etc., are available in Atlassian Cloud Cloud for purchase or trial subscription. HipChat Bitbucket Cloud is also supported by the ACLI Client and is currently available for a limited time at no charge. |
...
Expand | ||
---|---|---|
| ||
No, for for all servers except Crucible/FishEye.
|
Expand | ||
---|---|---|
| ||
Unlimited. Any number of users can install clients and connect to a server. The requirement is that the server host must have the the CLI Connector component component installed with valid license. |
Expand | ||
---|---|---|
| ||
Choose the product specific specific Command Line Interface (CLI Connector) if you want to use a client to connect to the Atlassian product. Choose the product specific specific Run CLI Actions app app for integrated capabilities like JIRA workflow actions, Confluence macros, Bamboo tasks, or similar product capabilities available with these apps. |
Expand | ||
---|---|---|
| ||
Each of the following product specific specific Command Line Interface (CLI) Marketplace Marketplace entries represent respective CLI Connectors (UPM installable). The links are provided as under:
The following clients do not need a Connectorconnector: |
...
Expand | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
The CLI client uses request/response protocol built on REST API calls provided by Atlassian. It perform performs remote actions against your Atlassian applications. |
Expand | ||
---|---|---|
| ||
Nothing specific to the app. The 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. |
Expand | ||
---|---|---|
| ||
The CLI Client authentication is different between for Cloud and Server versions of Confluence. For serverServer, authentication is based on the username and password provided when running the command from the CLI 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 | ||
---|---|---|
| ||
The risks in using this app are no different from performing the same operations via the Atlassian application user interface. CLI has only just those capabilities that Atlassian provided API offers. That said, as with any automation tool, we encourage our customers to carefully test their 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 | ||
---|---|---|
| ||
No. The CLI can perform only perform those operations that the user executing CLI can do are permitted to be executed via the Atlassian application's user interface. So, while it cannot be misused, it is very powerful and so should ; thus, must be used with caution and after thorough testing. |
Expand | ||
---|---|---|
| ||
The recourse or rollback options are identical to those in the UIuser interface. Some options to consider are making backups on of data that is about expected to be changed 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 | ||
---|---|---|
| ||
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 using minimal commands with this app. |
Expand | ||
---|---|---|
| ||
The CLI is a very powerful tool. 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 in the commands. Once that is understood well, creating it becomes easier to create CLI commands becomes easier. |
Expand | ||
---|---|---|
| ||
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 | ||
| ||
Check out the below How To sections 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 |