Git Scribe

Your AI copilot for crafting insightful Git commit messages

Git Scribe streamlines your development process by translating code diffs into concise narratives ✍️

Whenever you need inspiration, execute git commit and Git Scribe will suggest a message for you ✨

Getting Started

Follow these steps to add Git Scribe to your repository:

1. Install git-scribe and husky:

$ npm install --save-dev git-scribe husky

2. Enable Git hooks:

$ npx husky install

3. Add the prepare-commit-msg hook:

$ npx husky add .husky/prepare-commit-msg 'git-scribe "$1" "$2"'

Profit!

Data Privacy

Git Scribe uses OpenAI API behind the scenes. If you have any concerns, you can review OpenAI's API data privacy policies here.