@azadev/commit-gen
v2.2.2
Published
AI-powered commit message generator created by Azad for developers
Maintainers
Readme
🤖 @azadev/commit-gen
Groq + LLaMA 3.3 70B süni intellekt ilə işləyən git commit mesajı generatoru
@azadev/commit-gen
AI dəstəkli commit yaradıcı
──────────────────────────────────────────────────────
💡 Commit mesajını seç:
1 feat(auth): add JWT refresh token rotation logic
2 fix(session): resolve token expiry edge case on logout
3 refactor(middleware): simplify auth guard with token util
0) ✖ Ləğv edildi
──────────────────────────────────────────────────────
Seçim et (0-3): _✨ Xüsusiyyətlər
- 🧠 AI ilə avtomatik — stage edilmiş dəyişikliklərdən commit mesajı yaradır
- 🌐 3 interfeys dili — Azərbaycanca, İngiliscə, Türkcə
- 📝 3 commit mesajı dili — Azərbaycanca, İngiliscə, Türkcə
- 🔑 Bir dəfəlik quraşdırma — API açarı lokalda saxlanır, bir daha soruşulmur
- ⚡ Çox sürətli — Groq inferansı mövcud olan ən sürətli həllərdən biridir
- 🎨 Gözəl CLI — rəngli commit tipləri, spinner animasiyası, təmiz dizayn
- 🔒 Məlumatların təhlükəsizliyi — heç bir server istifadə edilmir, yalnız Groq API
- 🚫 Konflikt yoxdur —
azadev-commit-genadı digər paketlərlə toqquşmur
📦 Quraşdırma
Quraşdırma olmadan istifadə
npx @azadev/commit-genQlobal quraşdırma — gündəlik istifadə üçün tövsiyə edilir
npm install -g @azadev/commit-genQuraşdırmadan sonra istənilən git layihəsindən:
azadev-commit-genQeyd: Paket adı
@azadev/commit-gen, lakin shell komandasıazadev-commit-gen-dir. Bu, digərcommit-genadlı paketlərlə ad konfliktinin qarşısını alır.
🚀 Sürətli Başlanğıc
Addım 1 — Pulsuz Groq API açarı al
- console.groq.com saytına daxil ol
- Qeydiyyatdan keç — Google hesabı ilə də qeydiyyatdan keçə bilərsiniz
- API Keys bölməsinə keç → Create API Key düyməsinə bas
gsk_...ilə başlayan açarı kopyala
Groq şəxsi istifadə üçün tamamilə pulsuzdur. Ödəniş kartı tələb olunmur.
Addım 2 — Dəyişiklikləri stage et
git add .
# və ya konkret fayl yolunu da yaza bilərsən:
git add src/auth.tsAddım 3 — azadev-commit-gen işlət
# Qlobal quraşdırma ilə:
azadev-commit-gen
# Quraşdırma olmadan:
npx @azadev/commit-genYalnız ilk işlətmədə aşağıdakıları soruşacaq:
- İnterfeys dili seç — Azərbaycanca / İngiliscə / Türkcə
- Commit mesajı dili seç
- Groq API açarını daxil et
Hamısını yadda saxlayır və növbəti işlətmələrində birbaşa tanıyır.
🔄 İş axını
git add . → azadev-commit-gen → mesajı seç → commit atıldı ✔Heç bir konfiqurasiya faylına ehtiyyac yoxdur.
⚙️ Faydalı Komandalar
| Komanda | Nə edir |
| ------------------------------------ | ---------------------------------------------------- |
| azadev-commit-gen | Normal işlətmə — commit mesajı yarat |
| azadev-commit-gen --config | Config faylının yerini və məzmununu göstər |
| azadev-commit-gen --reset | Hər şeyi sıfırla — dil + API açarı yenidən soruşulur |
| azadev-commit-gen --reset-key | Yalnız API açarını sil |
| npx @azadev/commit-gen | Quraşdırma olmadan birbaşa işlət |
| npx @azadev/commit-gen --reset | Quraşdırma olmadan config sıfırla |
| npx @azadev/commit-gen --reset-key | Quraşdırma olmadan API açarını sil |
# Config faylın harada olduğunu görmək istəyirsənsə:
azadev-commit-gen --config
# Çıxış nümunəsi:
# 📁 @azadev/commit-gen config
#
# Mövcud konfiqurasiya:
# ──────────────────────────────────
# uiLang : az
# commitLang : en
# apiKey : gsk_••••••••••••••••
# ──────────────────────────────────
#
# Dili dəyişmək üçün → azadev-commit-gen --reset
# API açarı sıfırla → azadev-commit-gen --reset-key🌐 Dili Dəyişmək
Variant 1 — --reset ilə tam sıfırla
azadev-commit-gen --resetKomanda çalışdıqdan sonra növbəti azadev-commit-gen işlətməsində dil sehirbazı yenidən çıxacaq.
Variant 2 — Config faylını birbaşa düzəlt
Windows:
del %USERPROFILE%\.commit-gen\config.jsonmacOS / Linux:
rm ~/.commit-gen/config.jsonSonra azadev-commit-gen işlət — quraşdırma sehirbazı yenidən çıxacaq.
Variant 3 — Config faylını əl ilə redaktə et
~/.commit-gen/config.json faylını aç:
{
"apiKey": "gsk_...",
"uiLang": "az",
"commitLang": "en"
}Dəyərləri dəyiş:
| Sahə | Seçimlər | Açıqlama |
| ------------ | ------------------ | ---------------------------- |
| uiLang | az / en / tr | CLI interfeys dili |
| commitLang | az / en / tr | Yaradılan commit mesajı dili |
Faylı saxla — növbəti işlətmədən etibarən qüvvəyə minir.
📁 Config Faylının Yeri
| Əməliyyat sistemi | Yer |
| ----------------- | --------------------------------------- |
| Windows | C:\Users\<ad>\.commit-gen\config.json |
| macOS | /Users/<ad>/.commit-gen/config.json |
| Linux | /home/<ad>/.commit-gen/config.json |
🔑 API Açarını Sıfırlamaq
Variant 1 — Komanda ilə
azadev-commit-gen --reset-keyVariant 2 — commit-gen özü idarə etsin
Açar etibarsız olduqda commit-gen aşkar edib soruşacaq:
🔑 API açarını sıfırlamaq istəyirsiniz? (b/x):b bas → açar silinir → yenisini daxil etmək üçün yenidən işlət.
Variant 3 — Əl ilə
~/.commit-gen/config.json faylında apiKey dəyərini dəyiş:
{
"apiKey": "gsk_yeni_acarini_bura_daxil_et",
"uiLang": "az",
"commitLang": "en"
}🎨 Commit Tipləri — Rəng Bələdçisi
| Rəng | Tiplər |
| ------------ | ------------------------------ |
| 🟢 Yaşıl | feat — yeni funksionallıq |
| 🔴 Qırmızı | fix — xəta düzəltmə |
| 🟣 Bənövşəyi | refactor — kod təmizliyi |
| 🔵 Mavi | docs — sənədləşmə |
| 🟡 Sarı | style — formatlama |
| 🩵 Cyan | perf — performans |
| ⚪ Boz | chore, test, ci, build |
❓ Tez-tez Verilən Suallar
S: commit-gen əmri tanınmır, nə etməli?
C: Paket azadev-commit-gen adı ilə qeydiyyata alınıb. commit-gen əvəzinə azadev-commit-gen işlət. npx @azadev/commit-gen da işləyir.
S: Ödənişli Groq hesabı lazırdırmı? C: Xeyr. Groq-un pulsuz planı gündəlik commit generasiyası üçün kifayətdir.
S: Kodum hara göndərilir? C: Yalnız Groq API-a — inferans üçün. API açarın lokal config faylında saxlanır. Başqa heç bir serverə heç nə göndərilmir.
S: "Stage edilmiş dəyişiklik yoxdur" deyir?
C: Əvvəl git add . işlət. commit-gen yalnız git diff --cached — yəni stage edilmiş faylları oxuyur.
S: API açarını yenicə yaratdım amma etibarsız deyir? C: Groq konsolunda yeni açar yaratdıqdan sonra 10–15 saniyə gözlə — aktivləşməsi vaxt aparır. Sonra yenidən cəhd et.
S: Monorepo ilə işləyirmi?
C: Bəli. İstənilən alt qovluqdan azadev-commit-gen işlət — cari işçi qovluğun git kontekstini istifadə edir.
S: Necə silinir?
npm uninstall -g @azadev/commit-gen
rm -rf ~/.commit-gen # saxlanmış config və API açarını silir🛠 Tələblər
- Node.js 18+
- Git quraşdırılmış və PATH-də olmalıdır
- Pulsuz Groq API açarı
📦 @azadev Paketləri
Bu paket Azad Mirheydərzadə (azadev) tərəfindən yazılmışdır. Digər npm paketlərim:
| Paket | Açıqlama |
| -------------------------------------------------------------------------------- | ------------------------------------------- |
| @azadev/react-toastdev | React üçün səsli toast bildiriş kitabxanası |
| @azadev/commit-gen | AI ilə git commit mesajı generatoru |
📄 Lisenziya
MIT © Azad Mirheydərzadə
