@abhaydesu/git-pilot 1.0.1 → 1.0.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 +55 -0
- package/index.js +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Git Pilot
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@abhaydesu/git-pilot)
|
|
4
|
+
|
|
5
|
+
An AI-powered assistant that lives in your command line to streamline your Git workflow.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## ◼️ The Problem
|
|
9
|
+
Remembering complex commands like interactive rebase can be a pain. Writing well-formatted commit messages is a chore. Git is powerful, but its interface can sometimes get in the way of a fast workflow.
|
|
10
|
+
|
|
11
|
+
**Git Pilot** solves this by acting as your intelligent copilot, translating your natural language intent into the exact commands and messages you need.
|
|
12
|
+
|
|
13
|
+
## ◼️ Features
|
|
14
|
+
* **Natural Language to Git Command:** Translate plain English requests like "squash the last 3 commits" into the precise Git command (`git rebase -i HEAD~3`).
|
|
15
|
+
* **AI-Powered Commit Messages:** Analyzes your staged changes (`git diff`) and generates a perfect commit message following the Conventional Commits specification.
|
|
16
|
+
|
|
17
|
+
* **Interactive & Safe:** Always asks for your confirmation before executing any command, ensuring you're always in control.
|
|
18
|
+
|
|
19
|
+
## ◼️ Installation
|
|
20
|
+
Make sure you have Node.js (v18+) and Git installed. Then, run the following command to install Git Pilot globally:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install -g @abhaydesu/git-pilot
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### ◾ Usage
|
|
27
|
+
|
|
28
|
+
#### **Running a Git Command**
|
|
29
|
+
Run the run command with the task you want to perform in quotes.
|
|
30
|
+
|
|
31
|
+
```Bash
|
|
32
|
+
|
|
33
|
+
git pilot run "create a new branch called feature/auth"
|
|
34
|
+
```
|
|
35
|
+
The tool will suggest the correct Git command and ask for confirmation before executing it.
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
#### **Generating a Commit Message**
|
|
39
|
+
Stage your files (git add .).
|
|
40
|
+
|
|
41
|
+
Run the commit command with your intent in quotes.
|
|
42
|
+
|
|
43
|
+
```Bash
|
|
44
|
+
|
|
45
|
+
git pilot commit "add new user profile page"
|
|
46
|
+
```
|
|
47
|
+
The tool will suggest a message and ask for confirmation before committing.
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### ◾ How It Works
|
|
52
|
+
Git Pilot is a CLI tool that communicates with a secure backend API. This API uses Google's Gemini models to understand your intent and analyze code, keeping your API keys safe and off your local machine.
|
|
53
|
+
|
|
54
|
+
### ◾ License
|
|
55
|
+
This project is licensed under the MIT License.
|
package/index.js
CHANGED