JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q43865F
  • License MIT

A CLI tool for GitHub operations

Package Exports

  • git-whisper
  • git-whisper/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (git-whisper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Git Whisper ๐Ÿค–โœจ

Meet Git Whisper, your AI-powered companion for crafting perfect Git commit messages. This intelligent CLI tool eliminates the hassle of writing commit messages by generating clear, conventional, and contextually relevant commits automatically.

โœจ Key Features

  • ๐Ÿค– Smart commit message generation powered by AI
  • ๐Ÿ’ก Flexibility to choose your preferred LLM (GPT-4, Claude, and more)
  • ๐Ÿ“ Full compliance with conventional commit standards
  • ๐Ÿš€ Clean and user-friendly CLI interface
  • ๐Ÿ”„ Intelligent code change analysis for context-aware messaging

๐ŸŽฏ Why Git Whisper?

Git Whisper revolutionizes your Git workflow by automating commit message creation. It helps developers maintain professional commit histories while reducing mental overhead and saving valuable time.

๐Ÿš€ Getting Started

  1. Install globally via npm:
npm install git-whisper -g
  1. Set up with OpenRouter:
# Set your APIKey of OpenRouter
gw config set apikey

# Choose LLM
gw config set model

Your settings will be saved automatically to ~/.git-whisper/config.json.

  1. Start Using Git Whisper โค๏ธ
Command Description
gw Generate and execute commit message
gw --model anthropic/claude-3.5-sonnet Use a specific LLM for message generation
gw --interactive --commit-count 5 --dry-run Generate 5 commit messages interactively (preview only)
gw --language french Generate commit in french
gw --auto-add Add all staged changes
gw --auto-push Push on remote repository
gw config view apiKey View your current API key configuration
gw config view model View your current model configuration

๐Ÿงช Local Development

To set up Git Whisper for local testing:

  1. Build the project:

    npm run build:watch
  2. Run the CLI

    node ./dist/index.js

๐Ÿ› ๏ธ Built With

  • Node.js
  • OpenRouter API

๐Ÿ“‹ TODO

Here are some exciting features we're planning to add:

  • ๐ŸŽจ Custom commit message templates
  • ๐Ÿ”„ Git hook integration for automated commits
  • โšก Batch commit processing for multiple changes