unbrowse-contribute

1# Fix Unbrowse when it breaks
2 
3Unbrowse's client is open source. When it breaks in your hands, you hold the best bug report anyone
4will ever write: the exact command, the exact output and the code one `gh` away. Turn it into a fix
5the maintainers can merge, then carry on with the person's task.
6 
7## 1. Is it Unbrowse's fault?
8 
9Not bugs (follow the `unbrowse` skill instead):
10 
11- Exit `2` input required, `3` sign-in or site login needed, `4` not verified.
12- `no_capability`, a quota or credit error, `model_unavailable` on an index job.
13- The site's own 4xx, a CAPTCHA, or an input you got wrong.
14 
15Bugs:
16 
17- The CLI prints "This looks like a bug in Unbrowse", a stack trace or a `TypeError`.
18- An HTTP 5xx from `https://unbrowse.ai`, repeatable after one retry.
19- A documented command, flag, exit code or output field that does not behave as the docs say
20  (`unbrowse help`, `docs/cli.md`, the `unbrowse` skill).
21- A plugin hook that blocks a call it should allow, or lets through one it should redirect.
22- A verified result that is wrong for a site Unbrowse lists (`unbrowse site <host>`).
23 
24## 2. Write the report
25 
26```sh
27unbrowse bug "expected X, got Y"          # markdown: version, OS, Node, the last failure (secrets masked)
28unbrowse bug --json "expected X, got Y"   # the same as JSON
29```
30 
31The CLI keeps its last unexpected failure, redacted, in its config folder; `unbrowse bug` reads it.
32Add the shortest command that reproduces the problem. Never paste a token, cookie, password,
33…