https://github.com/olistic/git-scribe
✍️ AI copilot for crafting insightful Git commit messages
https://github.com/olistic/git-scribe
ai commit-message copilot git-hooks
Last synced: 8 months ago
JSON representation
✍️ AI copilot for crafting insightful Git commit messages
- Host: GitHub
- URL: https://github.com/olistic/git-scribe
- Owner: olistic
- License: mit
- Created: 2023-08-05T19:51:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-12T17:45:22.000Z (over 2 years ago)
- Last Synced: 2025-04-19T23:33:34.591Z (8 months ago)
- Topics: ai, commit-message, copilot, git-hooks
- Language: JavaScript
- Homepage:
- Size: 1.92 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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`](https://typicode.github.io/husky):
```sh
$ npm install --save-dev git-scribe husky
```
2. Enable Git hooks:
```sh
$ npx husky install
```
3. Add the [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook:
```sh
$ 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](https://openai.com/api-data-privacy).