scribe-git v0.1.20

Git Commit Message Generator

This project provides a command-line tool to automatically generate Git commit messages using AI. The tool leverages the DeepSeek Coder model to analyze staged changes and suggest appropriate commit messages, adhering to best practices in software development.

Table of Contents

• Features
• Installation
• Usage

Features

• AI-Powered Commit Messages: Utilizes an AI model to generate commit messages based on staged changes.
• Customizable Commit Types: Supports various commit types such as feat, fix, refactor, docs, chore, style, test, and localize.
• Interactive CLI: Provides an interactive command-line interface to confirm or modify suggested commit messages.
• Short and Long Messages: Option to generate short or comprehensive commit messages.
• Error Handling: Robust error handling for API communication, Git operations, and user interactions.
• PR Summary Generation: Generate a summary of changes for a Pull Request (PR) based on the last few commits.

Installation

To install the scribe-git globally, use the following command:

npm install -g scribe-git

Alternatively, you can use npx to run the tool without installing it globally:

npx scribe-git feat --key=your_api_key_here

Usage

Git Commit Message Generator [Node: 18.0.0, CLI: 1.0.0]

scribe-git <command> [options]

Commands:
  scribe-git feat [options]          Generate a commit message for a new feature
  scribe-git fix [options]           Generate a commit message for a bug fix
  scribe-git refactor [options]      Generate a commit message for code refactoring
  scribe-git docs [options]          Generate a commit message for documentation updates
  scribe-git chore [options]         Generate a commit message for maintenance tasks
  scribe-git style [options]         Generate a commit message for code style improvements
  scribe-git test [options]          Generate a commit message for test cases
  scribe-git localize [options]      Generate a commit message for localization efforts
  scribe-git pr <count>              Generate a PR summary from the last <count> commits

Options:
  --key             API key for the AI model (required for first-time use)   [string]
  --short, -s       Generate a short commit message                          [boolean]
  --long, -l        Generate a long commit message                           [boolean]

Examples:
  scribe-git feat --key=your_api_key_here
  scribe-git fix --short
  scribe-git pr 2

Interactive Response

The tool will prompt you:

1. To confirm or modify the AI-generated commit message.
2. To select the appropriate commit type if the AI suggestion differs from your original selection.