CLI Exit Codes

Exit codes returned by QNSP CLI commands.

Exit Codes

From packages/cli/src/config.ts:

export const EXIT_CODES = {
  SUCCESS: 0,
  GENERAL_ERROR: 1,
  INVALID_ARGUMENTS: 2,
  AUTH_ERROR: 3,
  AUTHORIZATION_ERROR: 4,
  NOT_FOUND: 5,
  RATE_LIMITED: 6,
  NETWORK_ERROR: 7,
} as const;

Code	Name	Description
0	SUCCESS	Command completed successfully
1	GENERAL_ERROR	Unspecified error occurred
2	INVALID_ARGUMENTS	Invalid command-line arguments
3	AUTH_ERROR	Authentication failed
4	AUTHORIZATION_ERROR	Insufficient permissions
5	NOT_FOUND	Requested resource not found
6	RATE_LIMITED	Rate limit exceeded
7	NETWORK_ERROR	Network connectivity issue

Using exit codes

Bash

qnsp kms keys get "$KEY_ID"
case $? in
  0) echo "Success" ;;
  5) echo "Key not found" ;;
  3) echo "Auth failed" ;;
  *) echo "Unknown error: $?" ;;
esac

Check specific code

qnsp vault secrets get "$SECRET_ID"
if [ $? -eq 5 ]; then
  echo "Secret doesn't exist"
fi

Verbose error info

Get detailed error information:

qnsp --verbose kms keys get invalid-id 2>&1
# Outputs detailed error with request ID

Machine-readable errors

qnsp kms keys get invalid-id --output json 2>&1

Returns:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Key not found",
    "requestId": "uuid"
  }
}