You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 15
Next »
Overview
This article provides answers to most frequently asked questions on the CLI app.
FAQ
Where exactly does this app run ?
Jira/Confluence/Bamboo/Bitbucket/Atlassian Command Line Interface (CLI) has 2 components
- CLI Connector - This is installed on the server using 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.
- CLI Client - This is installed on any system (Windows, Linux, OSX) that has Java 8 or higher. The CLI client runs on this system.
CLI client can be downloaded from Downloads - CLI Clients to the local machine where actions can be run from. Please see the page What is the difference between CLI clients and Run CLI add-ons?
Do clients still require an instance add-on (CLI Connector) be installed ?
Yes (with some exceptions). This has not changed. The Connector add-on provides license enforcement and, in some cases, extended remote interfaces not available from the base Atlassian product.
A few clients are provided at no charge and do not require a connector. They include:
Can clients be purchased separately ?
No. This has not changed. Clients are available for no-charge with the purchase of one or more of server or cloud add-ons.
What does an existing Run CLI Actions add-on customer need to do to remain properly licensed ?
Nothing if they do not use clients and only use the integrated support as part of their Atlassian product. Renew your license as normal when maintenance has expired.
If you want to use clients as well as the integrated capabilities, then a additional CLI license will be needed for the CLI Connector. This license change was effective in CLI version 6.x but only enforced when you upgrade your clients to 7.0 or higher. You are entitled to a discounted license (determined on your maintenance expiry date) - contact us at operations@appfire.com when needed.
How is it accessing Atlassian application ?
The CLI client uses request/response protocol built on REST API calls provided by Atlassian to perform remote actions against your Confluence and Jira instance.
What permissions does it require ?
Nothing specific to the app. The user's 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.
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 and if the user does not have specific permission, the user will not be allowed to perform the action using Confluence CLI app as well.
How the CLI authenticates to application ?
The authentication is different between cloud and server versions of Confluence. For server, 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 additional information on authentication, see this document.
Are there any risks, using this app ?
The risks in using this app are no different than performing the same operations via the Atlassian app's user interface. The CLI has only the capabilities that the Atlassian provided API offers. That said, as with any automation tool, we encourage our customers to carefully test their automation in test environments whenever possible. We also suggest using the simulate option to understand in detail what a given command does before using it live.
Can this app be misused beyond the Confluence permission of the users ?
No. The CLI can only perform operations that the user operating the CLI can do via the Atlassian app's user interface. So, while it cannot be misused, it is very powerful and so should be used with care and testing as discussed above.
What can be done, if the above happens ?
The recourse or rollback options are identical to those in the UI. Some options to consider are making backups on data about to be changed or making a plan to revert 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.
What 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 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 commands.
How easy is this app to learn ?
The CLI is a very powerful tool with over 200 actions available for Confluence. This can sometimes be a challenging learning curve until one understands the consistent patterns to the commands. Once that is understood, then creating commands becomes steadily easier.
We are setting up a few functional and performance test cases. Do you have any to test ?
