akapen 0.1.1 → 0.5.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 +25 -5
- package/dist/akapen.js +547 -222
- package/json-schema/config.json +949 -0
- package/json-schema/kinds.json +63 -0
- package/package.json +8 -3
package/README.md
CHANGED
|
@@ -1,13 +1,33 @@
|
|
|
1
1
|
# akapen
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Deep, multi-stage code review by a different model than the one that wrote the change: context research, reviewers with different lenses, a critic, and a verifier that checks every finding against the code. You get findings to fix, each with its evidence, or LGTM.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Reviewers
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
| `--reviewer` | Runs on | Needs |
|
|
8
|
+
| ------------ | ------------------------------------------------------------ | ---------------------------------------- |
|
|
9
|
+
| `codex` | Codex, through your ChatGPT subscription | the `codex` CLI, signed in |
|
|
10
|
+
| `claude` | Claude Code, through your Claude subscription | Claude Code, signed in |
|
|
11
|
+
| `api` | akapen's own agent harness, on the OpenAI and Anthropic APIs | `OPENAI_API_KEY` and `ANTHROPIC_API_KEY` |
|
|
12
|
+
|
|
13
|
+
All need Node.js 24 or later. With `api`, a review of a few hundred changed lines costs about $3–9, a re-review after fixes about $1–2. Reviewers never change your code; they can run small scripts in a sandbox (verified on macOS).
|
|
14
|
+
|
|
15
|
+
## Use it from your coding agent
|
|
16
|
+
|
|
17
|
+
In your repository, ask your coding agent (Claude Code or Codex):
|
|
18
|
+
|
|
19
|
+
> Run `npx akapen setup project` and set up akapen by following it.
|
|
20
|
+
|
|
21
|
+
Then ask it to run akapen (or "赤ペン入れて"). It reviews, checks each finding itself, fixes what holds up, and re-reviews until LGTM.
|
|
22
|
+
|
|
23
|
+
## Run it yourself
|
|
24
|
+
|
|
25
|
+
Run it from an empty directory and point it at the repository with `-C`, so `npx` does not read the reviewed branch's `.npmrc`:
|
|
8
26
|
|
|
9
27
|
```bash
|
|
10
|
-
|
|
28
|
+
R="$PWD"; OUT="$R/.git/akapen/last.json"; mkdir -p "$(dirname "$OUT")"
|
|
29
|
+
(cd "$(mktemp -d)" && npx akapen -C "$R" --reviewer codex --base main --out "$OUT") # the branch against main
|
|
30
|
+
(cd "$(mktemp -d)" && npx akapen -C "$R" --reviewer api --previous "$OUT" --out "$OUT") # a re-review after fixes
|
|
11
31
|
```
|
|
12
32
|
|
|
13
|
-
|
|
33
|
+
`npx akapen --help` lists the options, and `npx akapen validate -C "$R"` checks the settings before a review.
|