diff --git a/doc/03-cli.md b/doc/03-cli.md index cc193e162..99afcd5da 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -1068,13 +1068,18 @@ php composer.phar archive vendor/package 2.0.21 --format=zip ## audit -This command is used to audit the packages you have installed -for potential security issues. It checks for and -lists security vulnerability advisories using the -[Packagist.org api](https://packagist.org/apidoc#list-security-advisories) -by default or other repositories if specified in the `repositories` section of `composer.json`. +This command is used to audit the packages you have installed for potential security issues. It checks for and lists security +vulnerability advisories using the [Packagist.org api](https://packagist.org/apidoc#list-security-advisories) by default +or other repositories if specified in the `repositories` section of `composer.json`. +The command also detects abandoned packages. -The audit command returns the amount of vulnerabilities found. `0` if successful, and up to `255` otherwise. +The audit command determines if there are vulnerable or abandoned packages and returns the following exit codes based on +the findings: + +* `0` No issues; +* `1` Vulnerable packages; +* `2` Abandoned packages; +* `3` Vulnerable and abandoned packages. ```shell php composer.phar audit