korekt-cli 0.13.1 → 0.13.2
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 +34 -75
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,17 +4,7 @@
|
|
|
4
4
|
[](https://www.npmjs.com/package/korekt-cli)
|
|
5
5
|
[](https://www.npmjs.com/package/korekt-cli)
|
|
6
6
|
|
|
7
|
-
AI-powered code review
|
|
8
|
-
|
|
9
|
-
`kk` integrates seamlessly with your local Git workflow to provide intelligent code reviews powered by AI.
|
|
10
|
-
|
|
11
|
-
## Features
|
|
12
|
-
|
|
13
|
-
* **AI-Powered Analysis**: Get instant, intelligent code reviews with severity levels, categories, and actionable suggestions
|
|
14
|
-
* **Local Git Integration**: Works with committed changes, staged changes, and unstaged modifications
|
|
15
|
-
* **Ticket Context Enrichment**: Server-side ticket extraction from branch names and commit messages (Jira & Azure DevOps)
|
|
16
|
-
* **Beautiful Output**: Color-coded issues with severity indicators, file locations, and suggested fixes
|
|
17
|
-
* **Ultra-Fast**: Short command syntax (`kk`) for maximum developer efficiency
|
|
7
|
+
AI-powered code review from your terminal.
|
|
18
8
|
|
|
19
9
|
## Installation
|
|
20
10
|
|
|
@@ -22,112 +12,81 @@ AI-powered code review CLI - Keep your kode korekt
|
|
|
22
12
|
npm install -g korekt-cli
|
|
23
13
|
```
|
|
24
14
|
|
|
25
|
-
##
|
|
26
|
-
|
|
27
|
-
Configure the CLI with your API credentials:
|
|
15
|
+
## Setup
|
|
28
16
|
|
|
29
17
|
```bash
|
|
30
18
|
kk config --key YOUR_API_KEY
|
|
31
|
-
kk config --endpoint https://api.korekt.ai/api/review
|
|
32
19
|
```
|
|
33
20
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
# Review committed changes against a target branch
|
|
38
|
-
kk review main
|
|
39
|
-
|
|
40
|
-
# Review only staged changes
|
|
41
|
-
kk stg
|
|
42
|
-
|
|
43
|
-
# Review only unstaged changes
|
|
44
|
-
kk diff
|
|
21
|
+
## Local Workflow
|
|
45
22
|
|
|
23
|
+
### Review Your Changes
|
|
46
24
|
|
|
25
|
+
```bash
|
|
26
|
+
kk review main # Review commits against main
|
|
27
|
+
kk stg # Review staged changes
|
|
28
|
+
kk diff # Review unstaged changes
|
|
47
29
|
```
|
|
48
30
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
### Configuration
|
|
31
|
+
### Choose AI Model
|
|
52
32
|
|
|
53
33
|
```bash
|
|
54
|
-
#
|
|
55
|
-
kk
|
|
56
|
-
|
|
57
|
-
# Set API endpoint
|
|
58
|
-
kk config --endpoint https://api.korekt.ai/api/review
|
|
59
|
-
|
|
60
|
-
# Show current configuration
|
|
61
|
-
kk config --show
|
|
34
|
+
kk review -m # Interactive model picker
|
|
35
|
+
kk review -m gemini-3-flash-preview # Direct selection
|
|
62
36
|
```
|
|
63
37
|
|
|
64
|
-
|
|
38
|
+
Available models (ranked by recommendation):
|
|
65
39
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
40
|
+
1. **gemini-3-flash-preview** - Most efficient, recommended for daily use
|
|
41
|
+
2. **gemini-3-pro-preview** - Best quality for complex reviews
|
|
42
|
+
3. **gemini-2.5-pro** - High quality alternative
|
|
43
|
+
4. **gemini-2.5-flash** - Legacy, avoid
|
|
69
44
|
|
|
70
|
-
|
|
71
|
-
kk review main
|
|
45
|
+
### Ignore Files
|
|
72
46
|
|
|
73
|
-
|
|
47
|
+
```bash
|
|
74
48
|
kk review main --ignore "*.lock" "dist/*"
|
|
49
|
+
```
|
|
75
50
|
|
|
76
|
-
|
|
77
|
-
kk review main --dry-run
|
|
51
|
+
## CI/CD Integration
|
|
78
52
|
|
|
79
|
-
|
|
80
|
-
kk review main --json
|
|
53
|
+
### Post to Pull Request
|
|
81
54
|
|
|
82
|
-
|
|
83
|
-
kk
|
|
84
|
-
|
|
55
|
+
```bash
|
|
56
|
+
kk review --comment # Auto-posts findings to PR
|
|
57
|
+
```
|
|
85
58
|
|
|
86
|
-
|
|
87
|
-
kk diff
|
|
59
|
+
Works with GitHub Actions, Azure Pipelines, and Bitbucket Pipelines.
|
|
88
60
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
61
|
+
### Post to Ticket
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
kk review --post-ticket # Posts findings to linked Jira/Azure ticket
|
|
92
65
|
```
|
|
93
66
|
|
|
94
|
-
|
|
67
|
+
Ticket IDs are automatically extracted from branch names and commit messages.
|
|
95
68
|
|
|
96
|
-
|
|
69
|
+
### JSON Output
|
|
97
70
|
|
|
98
71
|
```bash
|
|
99
|
-
|
|
72
|
+
kk review main --json # Machine-readable output
|
|
100
73
|
```
|
|
101
74
|
|
|
102
75
|
## Environment Variables
|
|
103
76
|
|
|
104
|
-
You can also configure using environment variables:
|
|
105
|
-
|
|
106
77
|
```bash
|
|
107
78
|
export KOREKT_API_KEY="your-api-key"
|
|
108
|
-
export KOREKT_API_ENDPOINT="https://api.korekt.ai/api/review"
|
|
109
79
|
```
|
|
110
80
|
|
|
111
|
-
|
|
81
|
+
Alternative to `kk config --key`. Config file takes precedence.
|
|
112
82
|
|
|
113
83
|
## Help
|
|
114
84
|
|
|
115
|
-
For more options and detailed help:
|
|
116
|
-
|
|
117
85
|
```bash
|
|
118
86
|
kk --help
|
|
119
87
|
kk review --help
|
|
120
88
|
```
|
|
121
89
|
|
|
122
|
-
## Development
|
|
123
|
-
|
|
124
|
-
To run tests:
|
|
125
|
-
```bash
|
|
126
|
-
npm test
|
|
127
|
-
```
|
|
128
|
-
|
|
129
90
|
## License
|
|
130
91
|
|
|
131
|
-
MIT
|
|
132
|
-
|
|
133
|
-
See [LICENSE](./LICENSE) for details.
|
|
92
|
+
MIT - See [LICENSE](./LICENSE) for details.
|