Skip to content

Commit 7dd1dfc

Browse files
committed
feat(README.md): update README with new features
1 parent 5c3d101 commit 7dd1dfc

File tree

3 files changed

+58
-40
lines changed

3 files changed

+58
-40
lines changed

README.md

Lines changed: 39 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,49 @@
1-
# git-commit-ai
1+
# Git Commit AI — AI commit message generator CLI
22

3-
> AI-powered commit message generator for Git. Automate your git workflow with intelligent, conventional commit messages.
3+
[![npm version](https://img.shields.io/npm/v/@vavasilva/git-commit-ai)](https://www.npmjs.com/package/@vavasilva/git-commit-ai)
4+
[![npm downloads](https://img.shields.io/npm/dm/@vavasilva/git-commit-ai)](https://www.npmjs.com/package/@vavasilva/git-commit-ai)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
46

5-
A command-line tool that uses Large Language Models (LLMs) to analyze your staged changes and automatically generate [Karma-style](https://karma-runner.github.io/6.4/dev/git-commit-msg.html) / [Conventional Commits](https://www.conventionalcommits.org/) messages.
7+
> Generate Conventional Commit messages from staged git changes using LLMs (Ollama, llama.cpp, OpenAI, Anthropic, Groq).
68
7-
**Supported AI backends:** Ollama, llama.cpp, OpenAI (GPT-4), Anthropic (Claude), Groq (LLaMA)
9+
**git-commit-ai** is a CLI that analyzes your `git diff --staged` and suggests high-quality **Conventional Commits** (`type(scope): subject`) with an interactive confirm/edit/regenerate flow.
10+
11+
**Backends:** Ollama (local), llama.cpp (local), OpenAI (GPT models), Anthropic (Claude), Groq (Llama)
12+
13+
## Quick Start
14+
15+
```bash
16+
# Install
17+
npm install -g @vavasilva/git-commit-ai
18+
19+
# 1. Make changes to your code
20+
echo "console.log('hello')" > hello.js
21+
22+
# 2. Stage your changes
23+
git add hello.js
24+
25+
# 3. Generate commit message and commit
26+
git-commit-ai
27+
28+
# Output:
29+
# 📝 Generated commit message
30+
# feat: add hello.js script
31+
# [C]onfirm [E]dit [R]egenerate [A]bort? c
32+
# ✓ Committed: feat: add hello.js script
33+
```
34+
35+
## How it works
36+
37+
1. You stage your changes (`git add ...`)
38+
2. git-commit-ai reads `git diff --staged`
39+
3. A selected LLM backend proposes a Conventional Commit message
40+
4. You confirm, edit, regenerate, or abort (no commit happens until you confirm)
841

942
## Features
1043

1144
- **Multiple Backends** - Ollama (local), llama.cpp (local), OpenAI, Anthropic Claude, Groq
1245
- **Auto-Detection** - Automatically selects available backend
13-
- **Karma Convention** - Generates `type(scope): subject` format commits
46+
- **Conventional Commits** - Generates `type(scope): subject` format (Karma compatible)
1447
- **Interactive Flow** - Confirm, Edit, Regenerate, or Abort before committing
1548
- **Individual Commits** - Option to commit each file separately
1649
- **Dry Run** - Preview messages without committing
@@ -250,25 +283,6 @@ export ANTHROPIC_API_KEY="your-api-key"
250283
export GROQ_API_KEY="your-api-key"
251284
```
252285

253-
## Quick Start
254-
255-
```bash
256-
# 1. Make changes to your code
257-
echo "console.log('hello')" > hello.js
258-
259-
# 2. Stage your changes
260-
git add hello.js
261-
262-
# 3. Generate commit message and commit
263-
git-commit-ai
264-
265-
# Output:
266-
# 📝 Generated commit message
267-
# feat: add hello.js script
268-
# [C]onfirm [E]dit [R]egenerate [A]bort? c
269-
# ✓ Committed: feat: add hello.js script
270-
```
271-
272286
## Usage
273287

274288
```bash
@@ -464,7 +478,7 @@ ignore_patterns = ["dist/*", "*.generated.ts"]
464478
| `config --set <key=value>` | Set a config value |
465479
| `config --list-keys` | List all valid config keys |
466480

467-
## Commit Types (Karma Convention)
481+
## Commit Types (Conventional Commits)
468482

469483
| Type | Description |
470484
|------|-------------|

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
{
22
"name": "@vavasilva/git-commit-ai",
3-
"version": "0.3.2",
4-
"description": "AI-powered commit message generator using LLMs (OpenAI GPT-4, Anthropic Claude, Ollama, Groq). Automate git commits with Conventional Commits format.",
3+
"version": "0.3.3",
4+
"description": "CLI that generates Conventional Commit messages from staged git changes using LLMs (OpenAI, Anthropic, Ollama, Groq).",
55
"type": "module",
66
"main": "./dist/index.js",
7+
"exports": {
8+
".": "./dist/index.js"
9+
},
710
"bin": {
811
"git-commit-ai": "./dist/index.js"
912
},
@@ -34,22 +37,23 @@
3437
"keywords": [
3538
"git",
3639
"commit",
37-
"ai",
38-
"git-commit-ai",
39-
"commit-message-generator",
40+
"commit message",
41+
"commit message generator",
42+
"conventional commits",
43+
"conventional-commit",
44+
"semantic commit",
45+
"commitlint",
46+
"cli",
47+
"developer tools",
4048
"automation",
41-
"ollama",
49+
"llm",
50+
"ai",
4251
"openai",
43-
"gpt-4",
4452
"anthropic",
4553
"claude",
54+
"ollama",
4655
"groq",
47-
"llama",
48-
"llm",
49-
"cli",
50-
"karma",
51-
"conventional-commits",
52-
"developer-tools"
56+
"llama"
5357
],
5458
"author": "Wagner Silva",
5559
"license": "MIT",

0 commit comments

Comments
 (0)