Overview
| Excerpt |
|---|
This article provides answers to most frequently asked questions on the CLI app. |
...
| Expand | ||
|---|---|---|
| ||
Yes. CLI apps for Jira, Jira Service Desk, Confluence Cloud, etc. are available in Atlassian Cloud for purchase or trial subscription. HipChat Cloud is also supported by the ACLI Client and is currently available for a limited time at no charge. |
| Expand | ||
|---|---|---|
| ||
No, 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 must have the CLI Connector component installed and validly licensedwith valid license. |
| Expand | ||
|---|---|---|
| ||
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 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 Command Line Interface (CLI) 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 Connector: |
...
| 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 . It perform remote actions against your Confluence and Jira instanceAtlassian applications. |
| Expand | ||
|---|---|---|
| ||
Nothing specific to the app. The user's users standard Atlassian application permissions 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 Cloud and server Server versions of Confluence. For server, 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 additional information on authentication, see 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 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 to understand in detail what a given command does before using it in a live environment. |
| Expand | ||
|---|---|---|
| ||
No. The CLI can only perform operations that the user operating the executing CLI can do via the Atlassian appapplication's user interface. So, while it cannot be misused, it is very powerful and so should be used with care caution and testing as discussed above. |
| Expand | ||
|---|---|---|
| ||
The recourse or rollback options are identical to those in the UI. Some options to consider are making backups on data that is about to be changed or making a plan to revert the changes, if needed, via the CLI. For example, if using the CLI to create new users in bulk, one should have a CLI command ready 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 work. Many hours are saved daily by our customers. Some operations in the Atlassian user interface that require many clicks and many screens can be performed in single using minimal commands. |
| 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 one understands the consistent patterns to in the commands. Once that is understood well, then creating CLI commands becomes steadily easier. |
| Expand | ||
|---|---|---|
| ||
Our 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 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 |
...