git-ai-helper 1.0.0 → 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 +38 -0
- package/package.json +9 -2
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# 🤖 GIT-AI-HELPER
|
|
2
|
+
|
|
3
|
+
A minimal, terminal-native CLI tool built with **Node.js**.
|
|
4
|
+
It allows users to automatically generate professional, one-sentence commit messages instantly based on code changes using AI.
|
|
5
|
+
Automates the git actions (add -> commit -> push) with a single comand while having a control over it.
|
|
6
|
+
|
|
7
|
+
## ✨ Features
|
|
8
|
+
- Generate atomic commit messages file-by-file
|
|
9
|
+
- Interactive prompts to accept, regenerate, or edit messages
|
|
10
|
+
- Auto-stages and auto-pushes to your remote repository
|
|
11
|
+
- Securely powered by a remote proxy server
|
|
12
|
+
|
|
13
|
+
## 🛠️ Tech Stack
|
|
14
|
+
- **Node.js** (Runtime)
|
|
15
|
+
- **Simple-Git** (Git automation)
|
|
16
|
+
- **Axios** (API requests)
|
|
17
|
+
- **Gemini API** (AI integration)
|
|
18
|
+
|
|
19
|
+
## ⚙️ Setup & Installation
|
|
20
|
+
1. Install the package globally via npm:
|
|
21
|
+
```bash
|
|
22
|
+
npm install -g git-ai-helper
|
|
23
|
+
```
|
|
24
|
+
2. Navigate to your local git repository:
|
|
25
|
+
```bash
|
|
26
|
+
cd your-project-folder
|
|
27
|
+
```
|
|
28
|
+
3. Run the tool to analyze changes and generate commits:
|
|
29
|
+
```bash
|
|
30
|
+
gitify
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
#### NPM Package 👉 https://www.npmjs.com/package/git-ai-helper
|
|
34
|
+
|
|
35
|
+
## 💡 Usage Requirements
|
|
36
|
+
- **New Projects:** Run `git init`, add your GitHub remote (`git remote add origin <link>`), and run `gitify`.
|
|
37
|
+
- **Cloned Projects:** Make your changes and simply run `gitify`.
|
|
38
|
+
- **Note:** Git must be installed and initialized on your system.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "git-ai-helper",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
@@ -9,7 +9,14 @@
|
|
|
9
9
|
"scripts": {
|
|
10
10
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
11
11
|
},
|
|
12
|
-
"keywords": [
|
|
12
|
+
"keywords": [
|
|
13
|
+
"git",
|
|
14
|
+
"ai",
|
|
15
|
+
"gemini",
|
|
16
|
+
"automation",
|
|
17
|
+
"cli",
|
|
18
|
+
"commit-messages"
|
|
19
|
+
],
|
|
13
20
|
"author": "Vandana",
|
|
14
21
|
"license": "ISC",
|
|
15
22
|
"type": "commonjs",
|