/
Get started with the ACLI Shell

Get started with the ACLI Shell

The ACLI Shell is a modern, interactive command-line interface that simplifies working with the Appfire Command Line Interface (ACLI). It includes powerful features like inline completion, smart prompts, contextual help, and dynamic suggestions - all designed to make automation and scripting easier and more intuitive.

What is the ACLI Shell?

The ACLI Shell is a terminal-based interface that helps you:

  • Discover and run ACLI actions

  • Navigate available parameters and values

  • Get context-aware suggestions and completions

  • Validate commands in real time

Supported platforms

You can run the ACLI Shell on most standard terminals. We recommend using:

  • Windows: Windows Terminal app (includes PowerShell, Command Prompt, and more)

  • Linux: Most common terminal applications

  • macOS (Intel or Apple Silicon): Terminal, iTerm2, Hyper, and other standard terminals

We’re open to supporting additional platforms. If you notice any display issues in your preferred terminal, let us know.

How to start the ACLI Shell

To launch the ACLI Shell:

  1. Open your terminal.

  2. Run the acli start script:

    ./acli

  3. (Optional) Include a configured site as a parameter:

    ./acli mysite

If you don’t specify a site, the shell uses your configured default.

Once the shell starts, you can immediately begin typing an action. Try using the examplegear site - a public Appfire test site, to explore how actions work.

acli examplegear

Discover actions, parameters, and values

As you type, the ACLI Shell shows suggestions based on what you've entered.

  1. Actions

    • Begin typing an action name.

    • Press Tab to show matching actions.

    • Use the arrow keys to navigate.

    • Press Space to select an action and continue.

  2. Parameters

    • Once you choose an action, the shell prompts you with valid parameters.

    • Narrow the list by typing.

    • Use Tab, arrow keys, and Space to choose a parameter.

  3. Parameter values

    • The shell suggests values based on the parameter.

    • If the value requires site-specific data (for example, --space or --project), the shell queries the site and shows recent or available options.

    • Use Tab, arrow keys, and Space to select a value.

Use inline completion

Inline completion guides you through common parameter sequences based on the action and context. It is available across all clients.

Think of inline completion as email suggestions appearing in gray as you type. If you follow the suggested path, you can see options for the next parameter or value.

  • To accept a suggestion, press Tab.

  • Use the arrow keys to browse options.

  • Press Space to select and return to the command line.

If you change the recommended sequence, inline suggestions are no longer displayed.

Command validation and fuzzy search

The shell also checks your inputs in real time. If you enter an unrecognized action, site, or parameter, the shell highlights the error.

Fuzzy search helps match your input to available options logically and quickly. You’ll see results update interactively as you type.

Use slash commands for help and navigation

The ACLI Shell includes built-in /slash commands that help you get documentation, manage your session, and access support without leaving the shell.

General slash commands

  • /docs: View help and documentation, search for actions, and see how-to guides.

  • /info: Show configuration details, client/server versions, and shell info.

  • /support: Get support resources, contact channels, and tips.

  • /updates: Check for ACLI updates and install them.

  • /history: View and manage previously run actions.

  • /web: Manage and monitor the ACLI web service.

  • /settings: Adjust user interface and configuration settings.

  • /exit: Exit the shell (you can also press Ctrl+D).

Support slash commands

Use /support followed by one of these keywords:

  • overview: Get a summary of available support options.

  • news: See known issues or service alerts.

  • feedback: Share suggestions or report issues.

  • ask: Ask questions and browse answers from the Atlassian Community.

  • report: Submit a bug or request (login required).

  • requests: View your submitted requests (login required).

Reuse previous actions

The ACLI Shell keeps a history of the actions you run, so you can quickly reuse or edit past commands.

Recall recent actions:

  • Use the Up and Down arrow keys to scroll through your command history.

View all previous actions:

  • Run the /history command in the shell.

This shows a list of actions run in both the current and previous sessions.

Use output from a previous action:

The shell lets you pipe results from one action into another. For example:

acli examplegear --action getIssueList | acli examplegear --action sendMessage

We want your feedback!

We’re excited about the ACLI Shell and what it can do. Help us make it even better! Use the /support feedback command to share your thoughts or report bugs. Your input shapes future improvements.