You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README-en.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,8 +25,8 @@ This project is a review assistant, not a substitute for tests, security analysi
25
25
## Requirements
26
26
27
27
- Go 1.25.12 or later when building from source
28
-
- Git and a Git repository to review
29
-
- credentials for one supported model provider (not needed for `--preview`)
28
+
- Git 2.38.0 or later and a Git repository to review
29
+
- credentials for a supported LLM service (not needed for `--preview`)
30
30
31
31
## Installation
32
32
@@ -36,7 +36,7 @@ This project is a review assistant, not a substitute for tests, security analysi
36
36
go install github.com/koderover/zadig-review-agent@latest
37
37
```
38
38
39
-
`go install`honors the standard `GOPROXY` setting. To use a trusted proxy for one installation:
39
+
`go install`supports the standard `GOPROXY` setting:
40
40
41
41
```bash
42
42
GOPROXY=https://goproxy.cn,direct \
@@ -58,13 +58,13 @@ make build
58
58
59
59
## Quick start
60
60
61
-
Preview which files and rules would be used without contacting a model:
61
+
You can preview file filtering and rule resolution without contacting a model:
62
62
63
63
```bash
64
64
zadig-review-agent review --preview
65
65
```
66
66
67
-
Configure a provider. Keeping the API key in an environment variable avoids writing it to disk or shell history:
67
+
Configure the model. We recommend providing the API key through an environment variable to avoid writing it to disk or shell history:
68
68
69
69
```bash
70
70
zadig-review-agent config set model.protocol openai
@@ -170,7 +170,7 @@ Please report vulnerabilities according to [SECURITY.md](SECURITY.md), not throu
170
170
171
171
### Model is not configured
172
172
173
-
Set `model.name` and the provider settings, or export the corresponding `ZADIG_REVIEW_MODEL_*` variables. `--preview` works without model credentials.
173
+
Set `model.name` and the model service settings, or export the corresponding `ZADIG_REVIEW_MODEL_*` variables. `--preview` works without model credentials.
0 commit comments