sncommit 1.1.0 → 1.2.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 +15 -15
- package/dist/index.js +11003 -12262
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Sncommit
|
|
2
2
|
|
|
3
3
|
AI-powered git commit message generator with a beautiful TUI (Terminal User Interface).
|
|
4
4
|
|
|
@@ -22,8 +22,8 @@ AI-powered git commit message generator with a beautiful TUI (Terminal User Inte
|
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
24
|
# Clone the repository
|
|
25
|
-
git clone https://github.com/snvshal/
|
|
26
|
-
cd
|
|
25
|
+
git clone https://github.com/snvshal/sncommit.git
|
|
26
|
+
cd sncommit
|
|
27
27
|
|
|
28
28
|
# Install dependencies
|
|
29
29
|
bun install
|
|
@@ -42,7 +42,7 @@ npm link
|
|
|
42
42
|
First, configure your API key:
|
|
43
43
|
|
|
44
44
|
```bash
|
|
45
|
-
|
|
45
|
+
sncommit config
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
Use the arrow keys to navigate and **Enter** to edit settings.
|
|
@@ -53,28 +53,28 @@ Run the tool in any git repository:
|
|
|
53
53
|
|
|
54
54
|
```bash
|
|
55
55
|
# Run on currently staged files
|
|
56
|
-
|
|
56
|
+
sncommit
|
|
57
57
|
|
|
58
58
|
# Or stage all files and run (like git commit -am)
|
|
59
|
-
|
|
59
|
+
sncommit -a
|
|
60
60
|
|
|
61
61
|
# Push to remote after committing
|
|
62
|
-
|
|
62
|
+
sncommit -p
|
|
63
63
|
|
|
64
64
|
# Stage all files, commit, and push (like git commit -am && git push)
|
|
65
|
-
|
|
65
|
+
sncommit -ap
|
|
66
66
|
```
|
|
67
67
|
|
|
68
68
|
### Alias
|
|
69
69
|
|
|
70
|
-
You can use the short alias `
|
|
70
|
+
You can use the short alias `sc` instead of typing `sncommit`:
|
|
71
71
|
|
|
72
72
|
```bash
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
73
|
+
sc # Generate commit
|
|
74
|
+
sc -a # Stage all and commit
|
|
75
|
+
sc -p # Commit and push
|
|
76
|
+
sc -ap # Stage all, commit, and push
|
|
77
|
+
sc config # Open configuration
|
|
78
78
|
```
|
|
79
79
|
|
|
80
80
|
### 3. Workflow
|
|
@@ -87,7 +87,7 @@ bc config # Open configuration
|
|
|
87
87
|
|
|
88
88
|
## Configuration
|
|
89
89
|
|
|
90
|
-
Run `
|
|
90
|
+
Run `sncommit config` to modify:
|
|
91
91
|
|
|
92
92
|
| Setting | Description | Default |
|
|
93
93
|
| :---------------- | :-------------------------------------- | :--------------------- |
|