Quick start guide

The Appfire Command Line Interface (ACLI) helps you automate administrative and operational tasks across Atlassian and other supported platforms. This guide walks you through the essential steps to install and run your first ACLI command.

Step 1: Choose your installation method

You can install and run the ACLI in one of the following ways:

1. Install the server or cloud app

   • Requires admin access to your Atlassian instance (such as Jira, Confluence, or Bitbucket).

   • See the Server or Cloud Installation guide for instructions.

2. Download and install the ACLI client

   • Download the distribution ZIP from the official source.

   • Extract it to a local directory.

   • Use the provided startup scripts for customization.

   • See the CLI Client Installation and Use guide for full setup instructions.

Step 2: Run your first command

After installation, test the ACLI by running a simple command. For example, to get information about a Jira project:

Replace jira with the appropriate client name for your application, such as confluence or bitbucket.

To see all available actions for your client, run:

Step 3: Explore common resources

Here are key resources to help you explore the ACLI’s capabilities:

• Action reference: Full documentation for all supported actions.

• Examples: Auto-generated usage examples for every action.

• Client downloads: All ACLI clients are bundled in the same distribution.

• Comparison guide: Learn the difference between ACLI clients and Run CLI apps.

Step 4: Try a run script

ACLI also supports multi-action scripts using run and runFromList. For example:

This command loops through a list of project keys and retrieves each project.

Need help?

• Refer to the individual product documentation for client-specific actions.

• Use --help for usage details.

• Visit the support portal or community if you run into issues.