Exit Codes
==========

PipCanary Exit Codes, description and recommended actions.

+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Exit Code | Description                             | Recommended Action                                                                                                                                             |
+===========+=========================================+================================================================================================================================================================+
| -1        | Preconditions failed.                   | Fix precondition and rerun PipCanary.                                                                                                                          |
+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 0         | Scan and Audit successful.              | It is safe to continue.                                                                                                                                        |
+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 1         | Invalid argument value.                 | Fix arguments and rerun PipCanary.                                                                                                                             |
+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2         | Scanning process crashed.               | Check error message for details.                                                                                                                               |
+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3         | Failed to download package Information. | Fix connection to index and rerun PipCanary.                                                                                                                   |
+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 4         | Vulnerability or recent upload.         | Change requirements and/or PipCanary arguments and rerun PipCanary.                                                                                            |
+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 5         | Malicious activity detected.            | Hard Block & Quarantine: Immediately terminate the build. Delete workspace and alert the Incident Response (IR) team for a potential supply-chain attack.      |
+-----------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+