gitcoach-cli 1.1.2 → 1.1.3
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 +97 -73
- package/dist/utils/version.d.ts +1 -1
- package/dist/utils/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
2
|
|
|
3
3
|
```
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
██████╗ ██╗████████╗ ██████╗ ██████╗ █████╗ ██████╗██╗ ██╗
|
|
5
|
+
██╔════╝ ██║╚══██╔══╝██╔════╝██╔═══██╗██╔══██╗██╔════╝██║ ██║
|
|
6
|
+
██║ ███╗██║ ██║ ██║ ██║ ██║███████║██║ ███████║
|
|
7
|
+
██║ ██║██║ ██║ ██║ ██║ ██║██╔══██║██║ ██╔══██║
|
|
8
|
+
╚██████╔╝██║ ██║ ╚██████╗╚██████╔╝██║ ██║╚██████╗██║ ██║
|
|
9
|
+
╚═════╝ ╚═╝ ╚═╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝
|
|
10
10
|
```
|
|
11
|
-
|
|
12
11
|
**Interactive Git assistant that prevents mistakes before they happen.**
|
|
13
12
|
|
|
14
13
|
[](https://www.npmjs.com/package/gitcoach-cli)
|
|
15
14
|
[](https://github.com/DNSZLSK/gitcoach-cli)
|
|
16
15
|
[](https://opensource.org/licenses/MIT)
|
|
16
|
+
[](https://github.com/DNSZLSK/gitcoach-cli)
|
|
17
17
|
|
|
18
18
|
---
|
|
19
19
|
|
|
@@ -27,9 +27,9 @@ Git is powerful but brutal to beginners. Cryptic error messages, lost work from
|
|
|
27
27
|
- **Educational** - Shows every Git command being executed so you learn while you use it
|
|
28
28
|
- **Adapts to your level** - Beginner (verbose), Intermediate (balanced), Expert (minimal)
|
|
29
29
|
- **Multilingual** - Works in English, French, and Spanish
|
|
30
|
-
- **
|
|
30
|
+
- **5 AI integrations** - Uses GitHub Copilot CLI for commit messages, Git Q&A, diff summaries, error explanations, and conflict resolution (works without it too)
|
|
31
31
|
|
|
32
|
-
Built for the **GitHub Copilot CLI Challenge 2026**.
|
|
32
|
+
Built for the **[GitHub Copilot CLI Challenge 2026](https://dev.to/challenges/github-2026-01-21)**.
|
|
33
33
|
|
|
34
34
|
---
|
|
35
35
|
|
|
@@ -79,14 +79,14 @@ sudo apt-get install git
|
|
|
79
79
|
|
|
80
80
|
### 3. GitHub Copilot CLI (Optional)
|
|
81
81
|
|
|
82
|
-
For AI-powered commit messages
|
|
82
|
+
For AI-powered features (commit messages, Q&A, diff summaries, error explanations, conflict resolution):
|
|
83
83
|
|
|
84
84
|
```bash
|
|
85
|
-
npm install -g @
|
|
86
|
-
|
|
85
|
+
npm install -g @github/copilot
|
|
86
|
+
copilot login
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
GitCoach works perfectly fine without Copilot CLI
|
|
89
|
+
GitCoach works perfectly fine without Copilot CLI — all core features are available without it.
|
|
90
90
|
|
|
91
91
|
---
|
|
92
92
|
|
|
@@ -122,52 +122,14 @@ GitCoach adapts to your skill level:
|
|
|
122
122
|
| **Intermediate** | Short descriptions | All | Most | Hidden |
|
|
123
123
|
| **Expert** | Git commands | Destructive only | Critical only | Hidden |
|
|
124
124
|
|
|
125
|
-
Example in Expert mode:
|
|
126
|
-
```
|
|
127
|
-
? Main Menu
|
|
128
|
-
> [S] git status
|
|
129
|
-
[A] git add
|
|
130
|
-
[C] git commit
|
|
131
|
-
[P] git push
|
|
132
|
-
[L] git pull
|
|
133
|
-
```
|
|
134
|
-
|
|
135
125
|
### Error Prevention
|
|
136
126
|
|
|
137
127
|
GitCoach warns you BEFORE you make mistakes:
|
|
138
128
|
|
|
139
|
-
**Uncommitted changes
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
| You have uncommitted changes! |
|
|
144
|
-
| Switching branches will lose your work. |
|
|
145
|
-
| |
|
|
146
|
-
+------------------------------------------------+
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
**Detached HEAD:**
|
|
150
|
-
```
|
|
151
|
-
+--------------- Detached HEAD ------------------+
|
|
152
|
-
| |
|
|
153
|
-
| You are in detached HEAD state. |
|
|
154
|
-
| Your commits may be lost if you switch |
|
|
155
|
-
| branches without creating a new branch. |
|
|
156
|
-
| |
|
|
157
|
-
+------------------------------------------------+
|
|
158
|
-
|
|
159
|
-
? How do you want to resolve this?
|
|
160
|
-
> [C] Create a new branch
|
|
161
|
-
[M] Return to main branch
|
|
162
|
-
[S] Stash changes and return
|
|
163
|
-
[I] Ignore (advanced users)
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
**Force push:**
|
|
167
|
-
```
|
|
168
|
-
? You are about to FORCE PUSH. This rewrites remote history.
|
|
169
|
-
? Are you absolutely sure? (yes/no)
|
|
170
|
-
```
|
|
129
|
+
- **Uncommitted changes** — warns before branch switching
|
|
130
|
+
- **Detached HEAD** — detects and offers recovery options (create branch, return to main, stash)
|
|
131
|
+
- **Force push** — requires explicit confirmation
|
|
132
|
+
- **Merge conflicts** — guides you through resolution step by step
|
|
171
133
|
|
|
172
134
|
### Educational Mode
|
|
173
135
|
|
|
@@ -179,26 +141,26 @@ Every action shows the Git command being executed:
|
|
|
179
141
|
5 file(s) staged successfully.
|
|
180
142
|
```
|
|
181
143
|
|
|
182
|
-
You learn Git while using GitCoach.
|
|
144
|
+
You learn Git while using GitCoach. Eventually, you won't need it anymore. That's the goal.
|
|
145
|
+
|
|
146
|
+
---
|
|
183
147
|
|
|
184
|
-
|
|
148
|
+
## GitHub Copilot CLI Integrations
|
|
185
149
|
|
|
186
|
-
|
|
150
|
+
GitCoach uses Copilot CLI in **5 distinct ways**. All are optional — the tool works without Copilot.
|
|
187
151
|
|
|
188
|
-
|
|
189
|
-
? Generate message with AI? Yes
|
|
190
|
-
Generating...
|
|
152
|
+
### 1. Smart Commit Messages
|
|
191
153
|
|
|
192
|
-
|
|
154
|
+
Copilot analyzes your staged diff and suggests a conventional commit message:
|
|
193
155
|
|
|
156
|
+
```
|
|
157
|
+
Suggested: feat(auth): add OAuth2 authentication
|
|
194
158
|
? Use this message? (Y/n)
|
|
195
159
|
```
|
|
196
160
|
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
### Git Q&A (Optional AI)
|
|
161
|
+
### 2. Git Q&A
|
|
200
162
|
|
|
201
|
-
Ask Git
|
|
163
|
+
Ask any Git question in natural language from the Help menu:
|
|
202
164
|
|
|
203
165
|
```
|
|
204
166
|
? Your question: What's the difference between merge and rebase?
|
|
@@ -208,6 +170,66 @@ Ask Git questions if Copilot CLI is installed:
|
|
|
208
170
|
Use merge for shared branches, rebase for local cleanup.
|
|
209
171
|
```
|
|
210
172
|
|
|
173
|
+
### 3. Staged Diff Summary
|
|
174
|
+
|
|
175
|
+
Before committing, Copilot summarizes your staged changes so you can review the intent of your work before saving it:
|
|
176
|
+
|
|
177
|
+
```
|
|
178
|
+
+-------------- Summary of Changes ---------------+
|
|
179
|
+
| |
|
|
180
|
+
| Modified auth module: added OAuth2 flow with |
|
|
181
|
+
| token refresh. Updated user model to store |
|
|
182
|
+
| refresh tokens. |
|
|
183
|
+
| |
|
|
184
|
+
+--------------------------------------------------+
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### 4. Contextual Error Explanation
|
|
188
|
+
|
|
189
|
+
When a Git operation fails, Copilot explains the error in plain language alongside GitCoach's built-in help:
|
|
190
|
+
|
|
191
|
+
```
|
|
192
|
+
Error: failed to push some refs to 'origin/main'
|
|
193
|
+
|
|
194
|
+
+--------------- AI Explanation ------------------+
|
|
195
|
+
| |
|
|
196
|
+
| Your local branch is behind the remote. Pull |
|
|
197
|
+
| the latest changes first with 'git pull', then |
|
|
198
|
+
| try pushing again. |
|
|
199
|
+
| |
|
|
200
|
+
+-------------------------------------------------+
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### 5. AI-Assisted Conflict Resolution
|
|
204
|
+
|
|
205
|
+
When merge conflicts occur, GitCoach shows both versions and offers 5 options — including asking Copilot for a recommendation:
|
|
206
|
+
|
|
207
|
+
```
|
|
208
|
+
Your version (local):
|
|
209
|
+
name: master-version
|
|
210
|
+
|
|
211
|
+
Remote version:
|
|
212
|
+
name: feature-version
|
|
213
|
+
|
|
214
|
+
? What do you want to keep?
|
|
215
|
+
> Keep my version (local)
|
|
216
|
+
Keep the remote version
|
|
217
|
+
Keep both (combine)
|
|
218
|
+
Edit manually in my editor
|
|
219
|
+
Ask Copilot AI
|
|
220
|
+
|
|
221
|
+
Copilot suggests: CUSTOM
|
|
222
|
+
Neither version alone is correct. The optimal solution
|
|
223
|
+
is to keep a merged version that maintains backward
|
|
224
|
+
compatibility while accommodating the feature.
|
|
225
|
+
|
|
226
|
+
? Accept this suggestion? (Y/n)
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
All Copilot responses respect your language configuration (English, French, or Spanish).
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
211
233
|
### Branch Management
|
|
212
234
|
|
|
213
235
|
Create, switch, merge, and delete branches with guidance:
|
|
@@ -248,7 +270,7 @@ English, French, and Spanish. Localized confirmations:
|
|
|
248
270
|
- **simple-git** - Git operations
|
|
249
271
|
- **i18next** - Internationalization
|
|
250
272
|
- **Chalk** - Terminal styling
|
|
251
|
-
- **Jest** -
|
|
273
|
+
- **Jest** - 522 tests
|
|
252
274
|
|
|
253
275
|
---
|
|
254
276
|
|
|
@@ -281,7 +303,7 @@ gitcoach-cli/
|
|
|
281
303
|
│ │ ├── menus/ # Interactive menus
|
|
282
304
|
│ │ └── themes/ # Color themes
|
|
283
305
|
│ └── utils/ # Helpers, validators
|
|
284
|
-
├── test/ #
|
|
306
|
+
├── test/ # 522 tests
|
|
285
307
|
└── docs/ # Documentation
|
|
286
308
|
```
|
|
287
309
|
|
|
@@ -301,19 +323,21 @@ gitcoach-cli/
|
|
|
301
323
|
|
|
302
324
|
- **npm:** [npmjs.com/package/gitcoach-cli](https://www.npmjs.com/package/gitcoach-cli)
|
|
303
325
|
- **GitHub:** [github.com/DNSZLSK/gitcoach-cli](https://github.com/DNSZLSK/gitcoach-cli)
|
|
326
|
+
- **DEV.to:** [GitCoach — GitHub Copilot CLI Challenge](https://dev.to/dnszlsk/gitcoach-the-git-mentor-that-teaches-you-while-you-work-github-copilot-cli-challenge-1708)
|
|
304
327
|
- **Issues:** [github.com/DNSZLSK/gitcoach-cli/issues](https://github.com/DNSZLSK/gitcoach-cli/issues)
|
|
305
328
|
|
|
306
329
|
---
|
|
307
330
|
|
|
308
331
|
## Author
|
|
309
332
|
|
|
310
|
-
**DNSZLSK**
|
|
333
|
+
**DNSZLSK** — CDA Student at AFPA, France
|
|
311
334
|
|
|
312
|
-
Built for the [GitHub Copilot CLI Challenge 2026](https://dev.to/challenges/github).
|
|
335
|
+
Built for the [GitHub Copilot CLI Challenge 2026](https://dev.to/challenges/github-2026-01-21).
|
|
313
336
|
|
|
314
337
|
---
|
|
315
338
|
|
|
316
339
|
## License
|
|
317
340
|
|
|
318
|
-
MIT
|
|
319
|
-
|
|
341
|
+
MIT
|
|
342
|
+
```
|
|
343
|
+
|
package/dist/utils/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const APP_VERSION = "1.1.
|
|
1
|
+
export declare const APP_VERSION = "1.1.3";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/utils/version.js
CHANGED