...
...
Overview
Excerpt |
---|
This article provides answers to the most frequently asked questions on the CLI app. |
...
FAQs
Expand | ||
---|---|---|
| ||
Jira/Confluence/Bamboo/Bitbucket/Atlassian Command Line Interface (CLI) has 2 components:
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 | ||
---|---|---|
| ||
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. 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. |
Expand | ||
---|---|---|
| ||
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@appfirelicense@appfire.com when needed. |
Expand | ||
---|---|---|
| ||
Obtain a an evaluation license for one of the server add-ons Atlassian apps listed, install on serverthe app, and the then, download the ACLI client Client distribution. See CLI Client Installation and Use for more information. |
Expand | ||
---|---|---|
| ||
No for clients. Yes for other Run CLI Action products, however, some extended capabilities may not be available without the CLI Connector installed and licensed. Currently, there is only a handful of exceptions and an error message will indicate the limitation. . ACLI Client is not licensed to be used to access 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 affect effect at that time. Links are available in the Related Information section. |
...
Expand | ||
---|---|---|
| ||
Yes. This has changed for 7.0. The server specific CLI (Connector) add-on and Run CLI Action add-on are independent starting with 6.0. You must purchase both the CLI and Run CLI Action apps to use both the client and the product specific functions. |
Expand | ||
---|---|---|
| ||
Yes. Atlassian recognized recognised partners and members of the Atlassian Experts program Program can use the ACLI any CLI app free of charge for development, testing, or, demonstration purposes. A purchased commercial license is required when used to support hosted customers or other customer focused useprovide services to customers. See Add-ons for Atlassian Experts for more details. |
Expand | ||
---|---|---|
| ||
Yes. Purchase or trial a subscription corresponding to your product and user level for either JIRA, CLI apps for Jira, Jira Service Desk, or Confluence Cloud etc., are available in Atlassian Cloud for purchase or trial subscription. HipChat Bitbucket Cloud is also supported by the ACLI client 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 installed and validly licensed 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 add-on app for integrated capabilities like JIRA workflow actions, Confluence macros, Bamboo tasks, or similar integrated product capabilities available with the these add-onsapps. |
Expand | ||
---|---|---|
| ||
Each of the following product specific specific Command Line Interface (CLI) Marketplace Marketplace entries represent the respective CLI Connector Connectors (UPM installable). There is a single CLI Client (Windows, Linux, OSX installable) distribution that includes clients for all the specific products.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 to perform . It performs remote actions against your Confluence and Jira instanceAtlassian applications. |
Expand | ||
---|---|---|
| ||
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. |
Expand | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
| ||
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 |