ACLI Companion for Atlassian
This extension includes rich support for editing ACLI script files as well as help searching and building ACLI actions, as detailed below.
You can find additional information, tips and support for ACLI in:
To use this extension, you must have already installed ACLI version 10.4 or later.
Once installed, you will need to configure this extension with the location of your ACLI executable file, described in the "Extension Settings" section below.
Major features included with this extension are:
Check out our Walkthrough, which will help you configure and test the extension. From the Command Palette, type
The extension contributes the following settings:
You may also need to check whether or not your distribution adds a
Open the Command Palette and type ACLI to find all available ACLI commands.
ACLI: Open Documentation|Support|Community Site
ACLI: New Shell
This command opens a new ACLI shell in a new integrated terminal instance. The shell's rich auto-completion capabilities can be used to quickly compose and test ACLI actions against live Atlassian products (and more!). This can be useful when exploring or performing singular actions, or authoring or maintaining new ACLI script files in an editor.
ACLI: Run Script
This command runs the ACLI script in the current editor. The action output appears in a new Output channel (see Panels). The working directory for the script execution is the same directory that contains the script.
ACLI Script File Support
The extension supports syntax highlighting for ACLI script files (
Action and Parameter Mouse Hover Help
In an ACLI script, you can hover the mouse pointer over an action or parameter to display help information.
The diagnostics consist of a set of errors and warnings that help you to identify problems in your script, and point to unrecognized actions or parameters.
Parameter and Action Autocompletion
While ACLI Companion provides basic auto-completion for parameters and actions, note that the auto-completion available in the ACLI shell is far more powerful. (It is often useful to first construct an action in the shell or Action Builder, then insert the completed action into the script you are developing.)
When editing scripts, we recommend you to use
Use the Action Tools to explore and interact with the full range of ACLI actions. The ACLI Action Tools are available via the Activity Bar. Select the tab as shown to reveal what's available:
This is a tree view of actions, marked as your personal favorites. The view is empty to begin with, and it can be manually populated from the Action Explorer or the Action Builder (both described below).
The Action Explorer provides an interactive tree view of available ACLI Actions. Because ACLI contains hundreds of actions, this view only shows the most popular ones by default. The view controls on this section can be used to toggle between showing all actions or only those marked as popular.
Additional controls are:
Each action leaf of the tree also contains a context menu (right-click) and an edit button. The available actions here include:
A major feature of the extension is the the Action Builder view, use the "edit" button on an action name to access this view as described next.
The ACLI Action Builder provides a form-based view. The form-based view displays the parameters that an ACLI action requires to perform the work. As you fill out the form for a given action, the complete ACLI command is rendered underneath for later use.
The built command can be directly run, copied to the OS clipboard, or inserted into the last active editor (if there is one). You may also toggle Action Favorite entries from the builder form view.
This is currently a preview release -- expect quirks and bugs until 1.0.0, but your early feedback is invaluable.