You can run ACLI in an interactive console mode by using the run action. This mode is available for all clients and is useful when you want to manually execute multiple ACLI actions in a single session.

For a richer and more efficient experience, we recommend using the ACLI Shell. It offers a full terminal interface with advanced features like auto-completion and command history.


Run console mode for a specific client

To start console mode for a specific client, use the following command:

acli <client> -a run --continue

For example, to start console mode for a Jira instance:

acli examplegear.jira -a run --continue

Once you're in the console, you can enter any supported ACLI actions directly. Here's a sample session:

-a getServerInfo --outputFormat 2

Output:

Run: -a getServerInfo --outputFormat 2
Server info: 

Product . . . . . . . . . . . : Jira
Version . . . . . . . . . . . : 1001.0.0-SNAPSHOT
Base URL  . . . . . . . . . . : https://examplegear.atlassian.net
Title . . . . . . . . . . . . : Jira
Build . . . . . . . . . . . . : 100066
Build date  . . . . . . . . . : 10/16/17 8:00 PM
Current time  . . . . . . . . : 10/17/17 12:18 PM
License information . . . . . : License is valid.
Response time (milliseconds)  : 1357

Run additional actions as needed. For example:

-a getProjectList

Output:

Run: -a getProjectList
1 projects in list
"Key","Id","Name","Description","Lead","Default Assignee","Project Type","Project URL","JIRA URL"
"TEST","10000","Test","","automation","","software","","https://examplegear.atlassian.net/browse/TEST"

To get help for a specific action:

-a getIssueList --help

Output:

Run: -a getIssueList --help

getIssueList - List issues for a JQL query or by project.
    Required parameters: jql or project
    Optional parameters: file, dateFormat, limit, withId, suppressId, outputFormat, columns, encoding, append
    Output formats: 
      1 - default
      2 or 4 - custom fields
      3 or 4 - security level
      5 - 4 plus time values
      101 - issue keys only
      998 - all except custom
      999 - all

Run console mode across multiple clients

To start console mode without specifying a client, use the following command:

acli -a run --continue

In this mode, you can specify the client inline for each action.

For example:

examplegear.jira -a getServerInfo --outputFormat 2

Output:

Run: examplegear.jira -a getServerInfo --outputFormat 2
Server info: 

Product . . . . . . . . . . . : Jira
Version . . . . . . . . . . . : 1001.0.0-SNAPSHOT
Base URL  . . . . . . . . . . : https://examplegear.atlassian.net
Title . . . . . . . . . . . . : Jira
Build . . . . . . . . . . . . : 100066
Build date  . . . . . . . . . : 10/16/17 8:00 PM
Current time  . . . . . . . . : 10/17/17 12:25 PM
License information . . . . . : Not available for this Cloud instance.
Response time (milliseconds)  : 105

You can do the same for a different client:

examplegear.confluence -a getServerInfo --outputFormat 2

Output:

Run: examplegear.confluence -a getServerInfo --outputFormat 2
Server info: 

Product . . . . . . . . . . . : Confluence
Version . . . . . . . . . . . : 1000.0.0
Base URL  . . . . . . . . . . : https://examplegear.atlassian.net/wiki
Build . . . . . . . . . . . . : 6452
License information . . . . . : License is valid.
Response time (milliseconds)  : 498