1.0.8 β€’ Published 7 months ago

@auroraphtgrp01/commit v1.0.8

Weekly downloads
-
License
MIT
Repository
-
Last release
7 months ago

✨ @auroraphtgrp01/commit ✨

Version Powered by Gemini AI

Elevate your git workflow with AI-crafted commit messages


🌟 Overview

A sophisticated CLI tool that harnesses the power of Google's Gemini AI to craft elegant, meaningful commit messages. Say goodbye to the tedium of formatting and wordingβ€”let AI handle the details while you focus on your code.

πŸ‘¨β€πŸ’» Creator

auroraphtgrp01

Crafting elegant developer experiences

✨ Capabilities

  • AI-Powered Generation β€” Creates contextually relevant commit messages based on your staged changes
  • Conventional Format β€” Adheres to industry-standard commit conventions with appropriate emojis
  • Personalization β€” Offers the flexibility to select from AI suggestions or craft your own message
  • Streamlined Workflow β€” Features options to automatically stage changes and push commits
  • Elegant Interface β€” Presents a beautiful, intuitive CLI experience

πŸ’Ž Installation

# Global installation for regular use
npm install -g @auroraphtgrp01/commit

# Or use on demand without installation
npx @auroraphtgrp01/commit

βš™οΈ Configuration

Create an auroraphtgrp01.json configuration file in your project root:

{
  "model": "gemini-pro",
  "temperature": 0.5,
  "maxTokens": 2048,
  "geminiToken": "YOUR_GEMINI_API_TOKEN"
}

Obtain your Gemini API key from Google AI Studio

πŸš€ Usage

# Standard usage
npx @auroraphtgrp01/commit

# With workflow enhancements
npx @auroraphtgrp01/commit -a -p

Elegant Options

OptionEnhancement
-aGracefully stages all changes (git add .) before committing
-pSeamlessly pushes your changes after committing

Combine for a streamlined experience:

# Complete workflow: stage, commit, and push
npx @auroraphtgrp01/commit -a -p

πŸ”„ Refined Workflow

  1. Prepare β€” Stage your changes with git add (or use the elegant -a option)
  2. Generate β€” Invoke the tool to create AI-powered commit messages
  3. Select β€” Choose from thoughtfully crafted suggestions or compose your own
  4. Commit β€” Your changes are committed with the selected message
  5. Share β€” With the -p option, your work is automatically pushed to the remote repository

πŸ“ Practical Example

# Stage specific files with precision
git add src/components/Button.js

# Generate an elegant commit message
npx @auroraphtgrp01/commit

# Or execute the entire workflow in one command
npx @auroraphtgrp01/commit -a -p

πŸ“œ License

This project is gracefully licensed under the MIT License.