An introduction to the ACLI Shell

Description

Starting with the Atlassian CLI version 9.9, the Bob Swift team introduces the ACLI Shell - a new terminal app that provides prompts, helps discover actions, walks through available parameters and values, completes content, and then runs the action.

This significantly extends on the concept initially introduced with the earlier CLI Command Builder and is now a full replacement for this.

The ACLI shell works on many standard Linux and Mac command terminal apps. Windows users must use the modern Windows Terminal app. Windows Terminal includes PowerShell, Command Shell, and others.

We want your feedback on this important new feature of the ACLI. Use the /support feedback slash command and type in your comments and ideas!

How it works

To start the ACLI Shell app, just run the acli start script in a supported terminal with or without a single parameter referencing a configured site. If a site it not provided, your default site will be used if you have it configured. The acli start script runs actions normally like before if more than one parameter is provided.

Once in the app, just start typing your action … .

In this example, we use the publicly available Appfire site called examplegear available for demonstrations by typing acli examplegear

As you begin typing an action the ACLI shell will present a list of actions based on the text you type. To select an option press tab then use the up and down arrow keys to highlight the options. Press space bar to select the option and return to the ACLI shell command line.

Once you’ve selected an action the ACLI shell will present the parameters available for that action. Just like with actions the options available will narrow as you type a parameter name. Press tab and then use the up and down arrow keys to highlight the options. Press space bar to select the option and return to the ACLI shell command line.

Once you select a parameter the ACLI shell will provide suggested values for that parameter. If the parameter expects a value from the site you’ve selected (such as --project or --space) then the shell will query that site for values that you may select. For some parameters that may have a lot of possible values (like --issue or --page) the list of values will be based on your viewing history in the site, but won’t be every possible value.

Just like with actions and parameters the options available will narrow as you type a parameter value. Press tab and then use the up and down arrow keys to highlight the options. Press space bar to select the parameter value and return to the ACLI shell command line.

What Else Can ACLI Shell Do?

/slash commands

• docs: Show help and documentation, search for actions, links to how-tos and examples

• info: Show app help, configuration, client, and server information

• support: Show support information, links, and tips

• updates: Check for and install updates to maintain your installation

• history: Work with previous action results

• web: View status and manage the ACLI web service

• settings: Change user interface and configuration settings

• exit: Exit the shell session (Ctrl+D works also)

Get help (/support)

• overview: Support overview including links to helpful resources

• news: List of current issues that may impact your installation

• feedback: Provide feedback to ACLI developers

• ask: Ask a question and find answers about the ACLI from the Atlassian Community

• report: Report a problem or suggestion to support (login required)

• requests: Show previously reported requests (login required)

Ready for Something Even More Advanced?

Theme your ACLI shell (/settings theme)

Learn about creating your own themes here!

Recall previous actions (/history)

In the ACLI shell you can reuse previous actions even from previous ACLI shell sessions with the up arrow and down arrow keys.

Refer to results from previous actions

Results from actions are saved during ACLI shell sessions. This means that you can use the output from an action as an input into another action. In the example below we take the results from a getIssueList action and send them to Slack with the sendMessage action.

Have Ideas and Suggestions for Improvements?

We are truly excited for this revolutionary change in the Atlassian CLI experience! Please let us know about your experience with the /support feedback command. We’re eager to hear from you!

System Support

• Windows on Intel (amd64) - shells running via Windows Terminal app like PowerShell and others

• Linux on Intel (amd64) - many standard terminal apps

• Mac OS on Intel (amd64) - many standard terminal apps including terminal, iTerm2, Hyper, …

• Mac OS on Apple (arm64) - many standard terminal apps

We will consider supporting other hardware platforms based on user requests. Similarly, if you notice display problems with your favorite terminal program, give us feedback.