Understand exit codes for error handling in ACLI

ACLI takes care to return meaningful exit codes to the command processor. These codes make it easier to handle errors in automation scripts and CI/CD pipelines.

By default:

Standard output receives regular messages.
Standard error receives detailed error logs.

You can use the exit codes to programmatically respond to different types of errors.

Exit code reference

The following table describes the exit codes returned by ACLI. These codes can differ slightly between Windows and other operating systems.

Code Name	Exit Code (Windows)	Exit Code (Others)	Description

Code Name	Exit Code (Windows)	Exit Code (Others)	Description
`SUCCESS`	`0`	`0`	The command completed successfully.
`CLIENT_EXCEPTION`	`-1`	`255`	The client encountered a problem with the request and returned an error message.
`PARAMETER_PROBLEMHELP`	`-2`	`254`	The client found a syntax error or missing required parameters. A help request also returns this code.
`REMOTE_EXCEPTION`	`-3`	`253`	The remote system returned an error. The message comes from the server.
`CLIENT_SPECIFIC_EXCEPTION`	`-4`	`252`	The client detected a condition that requires a unique error classification. Examples: The `return` action in the System CLI indicates a user-defined error.
`SQL_EXCEPTION`	`-5`	`251`	The client encountered a database-related error while executing an SQL request.
`FAILURE`	`-99`	`157`	The client failed in an unexpected way. Consider opening a support ticket.