@hpreet/gitpilot 0.1.0 β 0.1.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 +122 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# GitPilot π
|
|
2
|
+
|
|
3
|
+
**AI-powered Git commit assistant** β generate meaningful, concise commit messages effortlessly. Designed to **fit seamlessly into your workflow** while keeping you productive and in control.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## π Features
|
|
8
|
+
|
|
9
|
+
* Generate commit messages with AI (OpenAI by default)
|
|
10
|
+
* Supports **local LLMs** (Ollama, LLaMA, etc.)
|
|
11
|
+
* Interactive mode: approve or edit AI-generated messages
|
|
12
|
+
* Optional **Git wrapper mode** (`git commit -ai`)
|
|
13
|
+
* Minimal setup: works out-of-the-box with `gitpilot setup`
|
|
14
|
+
* Configurable via **`~/.gitpilotrc`** or environment variables
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## β‘ Quick Start
|
|
19
|
+
|
|
20
|
+
### 1. Install GitPilot globally
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install -g @hpreet/git-pilot
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### 2. Setup your AI provider
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
gitpilot setup
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
* Follow the prompts:
|
|
33
|
+
|
|
34
|
+
* Choose provider (OpenAI or local LLM)
|
|
35
|
+
* Enter your API key if needed
|
|
36
|
+
* This creates your `~/.gitpilotrc` with defaults
|
|
37
|
+
|
|
38
|
+
### 3. Stage your changes
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
git add .
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 4. Generate a commit message automatically
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
gitpilot commit
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
* The AI will suggest a commit message
|
|
51
|
+
* You can approve or edit it (interactive mode)
|
|
52
|
+
|
|
53
|
+
### 5. Optional: provide your own message
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
gitpilot commit -m "Your commit message here"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 6. Advanced: Git wrapper mode
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
git commit -ai
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
* Uses GitPilot as a drop-in replacement for `git commit`
|
|
66
|
+
* Only enable if youβre comfortable replacing Git binary
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## β Configuration
|
|
71
|
+
|
|
72
|
+
GitPilot stores user preferences in:
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
~/.gitpilotrc
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Example:
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"provider": "openai",
|
|
83
|
+
"apiKey": "YOUR_API_KEY_HERE",
|
|
84
|
+
"defaultCommitStyle": "concise"
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
You can override settings using environment variables:
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
export GITPILOT_API_KEY="YOUR_API_KEY"
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## π§ Supported Providers
|
|
97
|
+
|
|
98
|
+
* **OpenAI** (default)
|
|
99
|
+
* **Local LLMs** (stub included; future support for Claude, GPT-4 local models)
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## π Contribution
|
|
104
|
+
|
|
105
|
+
GitPilot is open source!
|
|
106
|
+
|
|
107
|
+
* Report issues, suggest features, or contribute via PRs
|
|
108
|
+
* Code style: ESLint + Prettier
|
|
109
|
+
* Follow standard Git workflow: `git clone`, `npm install`, `npm link`
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## π License
|
|
114
|
+
|
|
115
|
+
MIT Β© Harpreet Singh
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## π¬ Contact
|
|
120
|
+
|
|
121
|
+
* GitHub: [https://github.com/singhhrpreet/git-pilot](https://github.com/singhhrpreet/git-pilot)
|
|
122
|
+
* Email: [thesinghharpreet@gmail.com](mailto:thesinghharpreet@example.com)
|
package/package.json
CHANGED