prreviewbuddy 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -0
- package/dist/log-DdPaO6Wo.js +6640 -0
- package/dist/main.js +873 -0
- package/dist/server.js +3849 -0
- package/package.json +27 -0
- package/static/comfortaa-700.woff2 +0 -0
- package/static/icon128.png +0 -0
- package/static/reviews.js +1 -0
- package/static/shell.css +2018 -0
- package/static/sidebar.css +4802 -0
- package/static/workspace.js +0 -0
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# PR Review Buddy
|
|
2
|
+
|
|
3
|
+
Review a branch, or a pull request, in an isolated checkout. From the terminal.
|
|
4
|
+
|
|
5
|
+
The analysis runs in a separate process against a git worktree pinned to one commit, so your own
|
|
6
|
+
checkout is never read or written while it works and you can carry on using it. The result is a
|
|
7
|
+
local workspace you open in a browser: a suggested path through the change, findings, questions,
|
|
8
|
+
and an assistant that has read the diff.
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
npm install -g prreviewbuddy
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Use
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
prreviewbuddy review review the current branch
|
|
20
|
+
prreviewbuddy review <pr-url> review the change on a pull request
|
|
21
|
+
prreviewbuddy review --base main compare against a base branch of your choosing
|
|
22
|
+
prreviewbuddy review --fresh review this branch again, keeping the existing review
|
|
23
|
+
|
|
24
|
+
prreviewbuddy open list your reviews and open the index
|
|
25
|
+
prreviewbuddy open <id> open one review
|
|
26
|
+
prreviewbuddy update bring the newest review of this repository up to date
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Run it from inside the repository you want reviewed.
|
|
30
|
+
|
|
31
|
+
## What you need
|
|
32
|
+
|
|
33
|
+
- **Node 20 or newer**, and **git**.
|
|
34
|
+
- **[Claude Code](https://claude.com/claude-code)**, installed and signed in. It does the analysis.
|
|
35
|
+
- **[GitHub CLI](https://cli.github.com/)** (`gh`), signed in, if you want the pull request
|
|
36
|
+
conversation read. Without it the review still runs, on the code alone, and says so.
|
|
37
|
+
|
|
38
|
+
There is no account, no API key and no configuration. Authentication stays between you and the
|
|
39
|
+
tools you already use; this never sees a token and never asks for one.
|
|
40
|
+
|
|
41
|
+
If you keep more than one Claude profile, set `CLAUDE_CONFIG_DIR` in the shell you run this from.
|
|
42
|
+
A review pins the environment it was created in, so it will keep using whichever profile it
|
|
43
|
+
started with.
|
|
44
|
+
|
|
45
|
+
## What to expect
|
|
46
|
+
|
|
47
|
+
The workspace URL is printed before the analysis starts and fills in as the review is made. The job
|
|
48
|
+
is durable: closing the terminal does not stop it, and running the same command again after an
|
|
49
|
+
interruption carries on from the phase that stopped rather than starting over.
|
|
50
|
+
|
|
51
|
+
Reviews are kept in `~/.prreviewbuddy` for thirty days. A local server holds them open and outlives
|
|
52
|
+
the terminal that started it, taking a new port each time it starts, so bookmark
|
|
53
|
+
`file://~/.prreviewbuddy/reviews.html` rather than a port number.
|
|
54
|
+
|
|
55
|
+
The isolated checkout a review was made in is kept for six hours after it finishes, because that is
|
|
56
|
+
what the assistant reads when you ask it questions, and is then removed.
|
|
57
|
+
|
|
58
|
+
## Also available
|
|
59
|
+
|
|
60
|
+
As a [Claude Code](https://claude.com/claude-code) plugin, and as a Chrome extension that reviews
|
|
61
|
+
pull requests in the browser.
|