kaniscope 0.26.0 → 0.26.1
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 +14 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -5,10 +5,19 @@ AI pull-request reviewer: fetches a PR's diff, reviews it, and posts line-anchor
|
|
|
5
5
|
This package ships a native binary — there is no Rust toolchain to install, no compile step, and no postinstall download. The binary lives in a small per-platform package that npm picks by `os`/`cpu`, so you download one, not five.
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install kaniscope
|
|
8
|
+
npm install -g kaniscope # want the `kaniscope` command on PATH
|
|
9
|
+
kaniscope --provider github --repo me/app --pr 12 --dry-run
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install kaniscope # building a bot? this is the one you want
|
|
9
14
|
npx kaniscope --provider github --repo me/app --pr 12 --dry-run
|
|
10
15
|
```
|
|
11
16
|
|
|
17
|
+
A plain `npm install kaniscope` is a **local** install, so it does not put `kaniscope` on your `PATH` — running it bare gives `command not found`. That is ordinary npm behaviour, not a broken install: reach it with `npx kaniscope`, or `./node_modules/.bin/kaniscope`, or install with `-g`.
|
|
18
|
+
|
|
19
|
+
For a bot, the local install is the right one anyway — `require("kaniscope")` works from it immediately and never touches `PATH`.
|
|
20
|
+
|
|
12
21
|
## As a library
|
|
13
22
|
|
|
14
23
|
Build a bot in TypeScript and drive the engine from it:
|
|
@@ -33,6 +42,10 @@ for (const f of out.findingsDetail ?? []) {
|
|
|
33
42
|
|
|
34
43
|
`review()` runs the binary and parses its JSON. It rejects when the engine exits non-zero, with `exitCode`, `signal` and the full `stderr` on the error.
|
|
35
44
|
|
|
45
|
+
## A complete bot
|
|
46
|
+
|
|
47
|
+
[`packaging/examples/node-bot`](https://github.com/nhatvu148/pr-review-core/tree/main/packaging/examples/node-bot) is a working GitHub review bot on this package — an HTTP server, webhook signature verification, and one `review()` call. It ships with tests that run against a fake engine, so they need no API key and no pull request.
|
|
48
|
+
|
|
36
49
|
## Configuration
|
|
37
50
|
|
|
38
51
|
Everything beyond the flags above — the model, the API key, provider tokens, file globs, confidence floors, bot identity — is read from the environment, exactly as it is for the Rust library. Pass overrides in `env` (merged over `process.env`, unless `inheritEnv: false`).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kaniscope",
|
|
3
|
-
"version": "0.26.
|
|
3
|
+
"version": "0.26.1",
|
|
4
4
|
"description": "AI pull-request reviewer — line-anchored inline comments plus a summary, for GitHub, GitLab and Bitbucket. Ships a native binary; no Rust toolchain required.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"code-review",
|
|
@@ -32,10 +32,10 @@
|
|
|
32
32
|
"README.md"
|
|
33
33
|
],
|
|
34
34
|
"optionalDependencies": {
|
|
35
|
-
"@nhatvu148/kaniscope-darwin-arm64": "0.26.
|
|
36
|
-
"@nhatvu148/kaniscope-darwin-x64": "0.26.
|
|
37
|
-
"@nhatvu148/kaniscope-linux-arm64": "0.26.
|
|
38
|
-
"@nhatvu148/kaniscope-linux-x64": "0.26.
|
|
39
|
-
"@nhatvu148/kaniscope-win32-x64": "0.26.
|
|
35
|
+
"@nhatvu148/kaniscope-darwin-arm64": "0.26.1",
|
|
36
|
+
"@nhatvu148/kaniscope-darwin-x64": "0.26.1",
|
|
37
|
+
"@nhatvu148/kaniscope-linux-arm64": "0.26.1",
|
|
38
|
+
"@nhatvu148/kaniscope-linux-x64": "0.26.1",
|
|
39
|
+
"@nhatvu148/kaniscope-win32-x64": "0.26.1"
|
|
40
40
|
}
|
|
41
41
|
}
|