gitbun 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 +75 -0
- package/package.json +3 -4
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Gitbun
|
|
2
|
+
|
|
3
|
+
Gitbun is an intelligent CLI tool that generates meaningful, context-aware Git commit messages for your staged changes. It leverages AI to analyze your codebase and commit diffs, helping you write better commit messages faster.
|
|
4
|
+
|
|
5
|
+
## Why Gitbun?
|
|
6
|
+
|
|
7
|
+
Writing clear, descriptive commit messages is essential for collaboration and project history. SmartCommit automates this process, saving time and ensuring consistency, especially for teams and open-source contributors.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
1. Clone the repository:
|
|
12
|
+
```sh
|
|
13
|
+
git clone https://github.com/nirvik34/gitbun.git
|
|
14
|
+
cd gitbun
|
|
15
|
+
```
|
|
16
|
+
2. Install dependencies:
|
|
17
|
+
```sh
|
|
18
|
+
npm install
|
|
19
|
+
```
|
|
20
|
+
3. (Optional) Link globally for CLI usage:
|
|
21
|
+
```sh
|
|
22
|
+
npm link
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
To generate a commit message for your staged changes, run:
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
smartcommit
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
You can also use it directly with npx:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
npx smartcommit
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Flags
|
|
40
|
+
|
|
41
|
+
- `--ai` Use AI-powered commit message generation (default: enabled)
|
|
42
|
+
- `--no-ai` Disable AI mode, use rule-based summarization
|
|
43
|
+
- `--interactive` Launch interactive mode for message editing
|
|
44
|
+
- `--config <path>` Specify a custom config file
|
|
45
|
+
- `--help` Show help and usage information
|
|
46
|
+
|
|
47
|
+
## AI Mode Explanation
|
|
48
|
+
|
|
49
|
+
When AI mode is enabled, SmartCommit uses a local or remote LLM (Large Language Model) to:
|
|
50
|
+
- Analyze your staged diffs
|
|
51
|
+
- Detect the scope and type of changes
|
|
52
|
+
- Summarize intent and impact
|
|
53
|
+
- Generate a clear, conventional commit message
|
|
54
|
+
|
|
55
|
+
If AI mode is disabled, SmartCommit falls back to a rule-based summarizer for basic commit messages.
|
|
56
|
+
|
|
57
|
+
## Requirements
|
|
58
|
+
|
|
59
|
+
- Node.js v18 or higher
|
|
60
|
+
- Git installed and available in your PATH
|
|
61
|
+
- (Optional for AI mode) Local LLM server (e.g., Ollama) or API access
|
|
62
|
+
|
|
63
|
+
## Example Output
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
$
|
|
67
|
+
[AI] feat(analyzer): add type classification for improved commit context
|
|
68
|
+
|
|
69
|
+
- Implemented typeClassifier to detect code change types
|
|
70
|
+
- Enhanced commit message quality with better context
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
For more details, see the [docs/](docs/) directory or run `gitbun --help`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "gitbun",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "A comfy git commit assistant with optional AI enhancement",
|
|
5
5
|
"main": "dist/src/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -44,12 +44,11 @@
|
|
|
44
44
|
"typescript": "^5.9.3"
|
|
45
45
|
},
|
|
46
46
|
"repository": {
|
|
47
|
-
|
|
48
|
-
|
|
47
|
+
"type": "git",
|
|
48
|
+
"url": "https://github.com/nirvik34/gitbun.git"
|
|
49
49
|
},
|
|
50
50
|
"bugs": {
|
|
51
51
|
"url": "https://github.com/nirvik34/gitbun/issues"
|
|
52
52
|
},
|
|
53
53
|
"homepage": "https://github.com/nirvik34/gitbun#readme"
|
|
54
|
-
|
|
55
54
|
}
|