Reference

Actions

These are the keywords that tell the CLI what action to take. The listed actions correspond to everything you can do via the screens on the app when you point, click, and type text into fields.

You see a pattern to the beginning or prefix that is an action verb such as: add, copy, export, get, modify, move, remove, run, store, update, and more depending on the app.

The ending or suffix to the action name is the noun or object of the verb such as attachment, comment, label, permission, user, and more depending on the app.

For example, the action addComment adds a comment to an item in the app.

Each app has its own features and set of actions,  in addition to the actions shared with other apps.

Parameters

Parameters tell the CLI the specific details needed to perform an action.  Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform the task.

The CLI requires at least one special parameter named action that tells what action to perform, without the action parameter, CLI displays help with some example actions. Parameters do not have prefixes like actions and are often specific to the app for the action. 

For example, the action getServerInfo requires details about the app or server from where the information is retrieved. To obtain the required information, the server parameter is used.

The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.

Example

An action and its parameters put together unlock the power to get things done with your apps.

The example shows how to retrieve information from an example Jira Cloud application with anonymous access in a multi-line format:

acli --action getServerInfo --server https://examplegear.atlassian.net --outputFormat 2

Action output:

Server info

Product . . . . . . . . . . . : Jira
Hosting . . . . . . . . . . . : cloud
Version . . . . . . . . . . . : 1001.0.0-SNAPSHOT
Base URL  . . . . . . . . . . : https://examplegear.atlassian.net
Title . . . . . . . . . . . . : Appfire Example Gear Jira
Build . . . . . . . . . . . . : 100221
Build date  . . . . . . . . . : 2023/04/10 8:02
License information . . . . . : Not available. Reason: Administrator access is required to get license information.
Client  . . . . . . . . . . . : jira
User  . . . . . . . . . . . . : anonymous
Response time (milliseconds)  : 638