scai 0.1.21 → 0.1.22
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 +0 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -58,28 +58,6 @@ This will download required models and set up scai.
|
|
|
58
58
|
|
|
59
59
|
### 🔧 Git Commands
|
|
60
60
|
|
|
61
|
-
- **Check Git status (better than `git status`):**
|
|
62
|
-
```bash
|
|
63
|
-
scai git status
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
This is an enhanced version of `git status`. It does more than just show the status of your working directory:
|
|
67
|
-
|
|
68
|
-
- **Check if your working directory is clean**: It tells you if there are any uncommitted changes.
|
|
69
|
-
- **Check your current branch**: It displays your current branch name.
|
|
70
|
-
- **Check if you're up to date with `origin/main`**: Unlike `git status`, which only shows local status, scai ensures you know if your branch is behind or ahead of the `origin/main` branch. It compares your local commit hash with the remote `origin/main` hash, giving you more comprehensive information.
|
|
71
|
-
|
|
72
|
-
Example output:
|
|
73
|
-
```
|
|
74
|
-
✅ Git working directory is clean
|
|
75
|
-
✅ Up to date with origin/main
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
If you're behind `origin/main`, it will show:
|
|
79
|
-
```
|
|
80
|
-
🔄 Branch <your-branch-name> is not up to date with origin/main
|
|
81
|
-
```
|
|
82
|
-
|
|
83
61
|
- **Suggest a commit message:**
|
|
84
62
|
```bash
|
|
85
63
|
git add .
|
|
@@ -98,14 +76,6 @@ This will download required models and set up scai.
|
|
|
98
76
|
|
|
99
77
|
### 🛠️ Generate Code-Related Output (`gen` commands)
|
|
100
78
|
|
|
101
|
-
- **Comment a code file:**
|
|
102
|
-
```bash
|
|
103
|
-
scai gen comm <file>
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
Adds clear, helpful comments to the code. Optional flag:
|
|
107
|
-
- `-a, --apply` — Overwrite the original file with the commented version.
|
|
108
|
-
|
|
109
79
|
- **Summarize a code file:**
|
|
110
80
|
```bash
|
|
111
81
|
scai gen summ <file>
|