Understand the different ACLI deployment options

Understand the different ACLI deployment options

Depending on your deployment needs and environment, you can use the Appfire Command Line Interface (ACLI) in multiple ways. These include standalone ACLI clients, product-specific connector apps, and embedded Run CLI Actions apps.

ACLI clients

ACLI clients are standalone command-line tools that run on a local system such as Windows, Linux, or macOS. These tools require Java 1.8 or later and are available as part of the Atlassian CLI distribution.

Clients connect to Atlassian products through remote APIs. They support access to any Atlassian server or Cloud instance that:

  • Has the required remote APIs enabled

  • Is running a supported product version

For licensing details, see the ACLI License.

ACLI connectors

ACLI Connectors are product-specific apps that must be installed on the Atlassian server you want to access. These connectors:

  • Enable server-based licensing

  • Can offer additional services for ACLI clients

System administrators must install and license the appropriate connector for the target application.

Run CLI Actions apps

Run CLI Actions are product-specific apps that embed ACLI capabilities directly within the Atlassian app. These apps:

  • Eliminate the need for a separate ACLI installation

  • Include an internal version of the Atlassian CLI for convenience

  • Allow you to execute ACLI actions using the same syntax and logic as external ACLI clients

Key benefits

  • Run CLI actions inside Jira (for example, through workflow functions or the UI)

  • Use ACLI macros inside Confluence pages

  • Automate or integrate with any ACLI-supported external system

You must provide the necessary parameters when running actions, including the server URL for the target Atlassian product.

Run CLI Actions apps are licensed separately as Atlassian paid add-ons. In most cases, you can use these apps to perform actions on remote instances without requiring an ACLI Connector on the remote system.

Comparison of deployment options

Category

Description

Deployment options

Category

Description

Deployment options

Connector Apps

Creates a connection between ACLI clients and an Atlassian application instance. A system administrator must install and license the connector.

Data Center

Run CLI Actions

An all-in-one embedded solution offering the full power of every ACLI client within your Atlassian apps. Supports execution using Jira workflows or Confluence macros.

Data Center, Cloud

If you encounter display or compatibility issues with your preferred terminal or app, send us feedback. We regularly evaluate support for additional platforms based on user requests.