Last updated Mar 31, 2025

Troubleshooting guide

Common flags

When you run commands on multiple entities, such as deleting multiple workitems, you don't need to halt the entire batch process if a single failure occurs. In such scenarios, you can utilize the --ignore-errors flag with acli to allow the continuation of subsequent actions regardless of encountered errors.

Exporting results to a JSON file is crucial for enabling the reuse of outcomes in other commands or scripts. This feature is facilitated by an option named --json, which mandates the creation of a JSON file as the output.

Certain commands can accept a JSON file as input. To explore the supported JSON file format, users can include the --generate-input-json option, which provides a default JSON template.

Error Handling

A trace ID is provided when an unexpected error happens on the backend:

1 unexpected error, trace id: XXXXXXXX

Copy and save the trace ID in a secure location; it may be requested by Atlassian support when troubleshooting issues.

When an expected error occurs, we simply present an error message without a trace ID.

  • Single Command Errors: If a single command fails a single trace ID is provided for troubleshooting. you can mention this trace ID in support tickets.
  • Bulk Command Errors: If bulk command requests fail (e.g., 2 out of 5), there will be trace IDs of all the unsuccessful requests.

The error message should clearly communicate the issue and list the relevant trace IDs for your reference.

Getting Help

At every stage of the command hierarchy, assistance is accessible. To obtain help at the overall command-line level, execute:

1
2
$ acli help [path to the command]

If you require help specific to Jira, utilize the command below:

1
2
$ acli jira --help

This method extends to the detailed level of a particular command as well:

1
2
$ acli jira workitem create --help  

Provide feedback

If you wish to provide feedback about the feature at any time, you can execute the task using the command line:

1
2
$ acli feedback -s "Summary of the feedback" -e anna@pandora.com -d "More details"

Status Codes

The Atlassian CLI uses the standard HTTP status codes

Operations that return an error status code may also return a response body containing details of the error or errors.

Rate this page: