Skip to content

AI-powered Raycast extension for generating meaningful Git commit messages by analyzing repository changes

License

Notifications You must be signed in to change notification settings

chihkang/gitcommiter

Repository files navigation

GitCommiter

GitCommiter is an AI-powered tool designed to generate meaningful Git commit messages by analyzing repository changes. This extension simplifies your commit process by providing context-aware commit summaries and detailed descriptions.

Features

  • 🤖 AI-Powered Commit Message Generation: Automatically generates concise and descriptive commit messages.
  • 📝 Commit Summaries and Detailed Descriptions: Provides both high-level summaries and detailed commit messages.
  • 🔍 Context-Aware Analysis: Analyzes repository changes to tailor commit messages to your specific modifications.
  • 💡 Consistent and Professional Commit History: Helps maintain a clean and standardized commit history.

Prerequisites

⚠️ Important: This extension requires:

  • A Raycast Pro subscription with AI features enabled.
  • Git installed on your system.
  • A valid Git repository with uncommitted changes.

Installation

  1. Install Raycast.
  2. Search for "GitCommiter" in the Raycast Store.
  3. Install the extension.
  4. Ensure you have an active Raycast Pro subscription with AI features.

Usage

  1. Open Raycast.
  2. Type "Generate Commit Message".
  3. Input your Git repository path.
  4. The AI will analyze your changes and generate appropriate commit messages.
  5. Review and use the generated commit messages in your workflow.

Configuration

GitCommiter offers several configuration options:

Git Settings

  • Git Installation Path: Optionally specify a custom Git executable path.
  • Default Branch: Set your preferred default branch name.

Commit Message Preferences

  • Commit Message Style: Choose between:
  • Conventional Commits (e.g., "feat: add new feature").
  • Detailed Description (with extended body).
  • Simple Summary (brief one-line messages).

Commands

  • Add Repository Path: Easily add new Git repository paths.
  • Remove Repository Paths: Remove unnecessary repository paths.
  • Generate Commit Message: Use AI to create commit messages from your repository changes.

Examples

Conventional Commit Style

  • Example: feat: add new feature

This extension streamlines the commit process, ensuring your commit history is both informative and professional. Enjoy seamless integration with Raycast and effortless commit message generation.

About

AI-powered Raycast extension for generating meaningful Git commit messages by analyzing repository changes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published