> ## Documentation Index
> Fetch the complete documentation index at: https://octolens.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Exit codes

> Exit codes are frozen — branch on codes (and the error envelope's code), never on message text.

Exit codes are frozen — branch on codes (and the error envelope's `code`), never on message text. Codes are `0` success · `1` unexpected · `2` usage · `3` auth · `4` not found · `5` permission/scope · `6` plan/limit · `7` rate-limited · `8` cancelled (a human aborted a prompt with EOF/Ctrl-C) · `9` the command ran and the operation did not succeed at its target · `10` a write was accepted and its answer lost — verify, do not retry.

Branching on the map from a script:

```sh theme={null}
octolens mentions list --json > mentions.json
case $? in
  0) echo "wrote mentions.json" ;;
  3) octolens login ;;    # auth: get a credential, then re-run
  7) sleep 60 ;;  # rate-limited: back off, then re-run
  *) echo "read the error envelope on stderr" >&2 ;;
esac
```

## The exit map

| Exit | Name            | Meaning                                                         |
| ---- | --------------- | --------------------------------------------------------------- |
| `0`  | `OK`            | success                                                         |
| `1`  | `UNEXPECTED`    | unexpected                                                      |
| `2`  | `USAGE`         | usage                                                           |
| `3`  | `AUTH`          | auth                                                            |
| `4`  | `NOT_FOUND`     | not found                                                       |
| `5`  | `PERMISSION`    | permission/scope                                                |
| `6`  | `LIMIT`         | plan/limit                                                      |
| `7`  | `RATE_LIMITED`  | rate-limited                                                    |
| `8`  | `CANCELLED`     | cancelled (a human aborted a prompt with EOF/Ctrl-C)            |
| `9`  | `FAILED`        | the command ran and the operation did not succeed at its target |
| `10` | `INDETERMINATE` | a write was accepted and its answer lost — verify, do not retry |