@kroszborg/sugi 0.1.0 → 0.2.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 +59 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# sugi
|
|
2
|
+
|
|
3
|
+
> Terminal UI git client — faster than lazygit, with AI commit messages and GitHub/GitLab PR integration.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install -g @kroszborg/sugi
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Or via Homebrew:
|
|
14
|
+
```sh
|
|
15
|
+
brew install Kroszborg/tap/sugi
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Or via Go:
|
|
19
|
+
```sh
|
|
20
|
+
go install github.com/Kroszborg/sugi/cmd/sugi@latest
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
Run inside any git repo:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
sugi
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Keybindings
|
|
32
|
+
|
|
33
|
+
| Key | Action |
|
|
34
|
+
|-----|--------|
|
|
35
|
+
| `1` / `2` / `3` / `4` | Switch panels (Files / Branches / Commits / Diff) |
|
|
36
|
+
| `tab` | Next field |
|
|
37
|
+
| `s` | Stage / unstage file |
|
|
38
|
+
| `c` | Open commit form |
|
|
39
|
+
| `ctrl+g` / `alt+g` | Generate AI commit message (requires Groq API key) |
|
|
40
|
+
| `ctrl+s` | Commit |
|
|
41
|
+
| `b` | Blame view |
|
|
42
|
+
| `z` | Stash panel |
|
|
43
|
+
| `R` | Reflog |
|
|
44
|
+
| `O` | Settings (add Groq API key here) |
|
|
45
|
+
| `?` | Help |
|
|
46
|
+
| `q` | Quit |
|
|
47
|
+
|
|
48
|
+
## AI Commit Messages
|
|
49
|
+
|
|
50
|
+
sugi uses [Groq](https://console.groq.com) (free tier available) to generate conventional commit messages from your staged diff.
|
|
51
|
+
|
|
52
|
+
1. Press `O` to open Settings
|
|
53
|
+
2. Add your Groq API key
|
|
54
|
+
3. Stage your changes, open commit form with `c`
|
|
55
|
+
4. Press `ctrl+g` or `alt+g` to generate
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT © [Kroszborg](https://github.com/Kroszborg)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kroszborg/sugi",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "Terminal UI git client —
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Terminal UI git client — PRs, AI commits, interactive rebase, bisect, worktrees",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"git",
|
|
7
7
|
"tui",
|
|
@@ -29,7 +29,8 @@
|
|
|
29
29
|
},
|
|
30
30
|
"files": [
|
|
31
31
|
"bin.js",
|
|
32
|
-
"install.js"
|
|
32
|
+
"install.js",
|
|
33
|
+
"README.md"
|
|
33
34
|
],
|
|
34
35
|
"engines": {
|
|
35
36
|
"node": ">=16"
|