Reference
What each Broom exit code means, and what counts as an issue for each command.
| Code | Meaning |
|---|---|
0 | Success, nothing to report. |
1 | Execution error (for example not a git repository, a failed deletion or kill, an unexpected error). |
2 | Invalid arguments or configuration, missing directory, or a confirmation was required but no terminal was available. |
3 | The audit found issues. |
| Command | Exits 3 when |
|---|---|
env | Missing, undocumented, duplicate, client-exposed or definitely unused variables. |
clean | Any high or medium confidence candidate. |
deps | Any confirmed finding, possibly unused or misplaced dependency. |
doctor | Any failed or warning check that was not fixed. |
stats, ports, recap | Never. They exit 0 on success. |
broom doctor --quietstatus=$?if [ "$status" -eq 3 ]; then echo "Broom found issues"; fiFound a problem in these docs? Open an issue on GitHub.