1.0.0 • Published 4 months ago

gitsage v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
4 months ago

GitSage

An intelligent Git commit message generator powered by OpenAI's GPT-4. This tool analyzes your staged changes and automatically generates meaningful, conventional commit messages.

Features

  • 🤖 AI-powered commit message generation
  • 📝 Conventional commit format support
  • 🔍 Smart change analysis and grouping
  • ✨ Interactive commit message selection
  • 🛠️ Easy configuration and setup

Quick Start

You can use gitsage directly without installation using npx:

npx gitsage

Optional Installation

If you prefer, you can install the package globally:

npm install -g gitsage

Configuration

Before using gitsage, you'll need to configure your OpenAI API key. The tool will prompt you for the key on first use, or you can set it up manually:

  1. Get your API key from OpenAI's platform
  2. The tool will automatically store your API key securely for future use

Usage

  1. (Optional) Stage your changes using git add:
git add <files>
  1. Run gitsage:
gitsage
  1. Review and confirm the generated commit messages

Note: If no changes are staged, gitsage will automatically help you select which files to stage through an interactive interface. This makes the staging process optional and more user-friendly.

How It Works

  1. Analyzes staged Git changes
  2. Splits large diffs into manageable chunks
  3. Uses GPT-4 to analyze changes and generate appropriate commit messages
  4. Groups related changes together
  5. Presents commit suggestions for your approval
  6. Creates commits using conventional commit format

Commit Types

The tool generates commits following the conventional commits specification:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • style: Code style changes (formatting, etc.)
  • refactor: Code refactoring
  • perf: Performance improvements
  • test: Adding or updating tests
  • chore: Maintenance tasks

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes using the tool itself! (gitsage)
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Powered by OpenAI's GPT-4
  • Inspired by conventional commits
  • Built with TypeScript and Node.js
cli-blockcommanderdotenvinquireropenaits-nodetypescript
1.0.0

4 months ago