https://github.com/segersniels/genmoji
Generate commit messages from code snippets or your diff
https://github.com/segersniels/genmoji
ai chatgpt commit commit-message diff generate
Last synced: 7 months ago
JSON representation
Generate commit messages from code snippets or your diff
- Host: GitHub
- URL: https://github.com/segersniels/genmoji
- Owner: segersniels
- Created: 2023-03-26T00:25:24.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T18:17:36.000Z (over 1 year ago)
- Last Synced: 2024-04-24T03:35:36.382Z (over 1 year ago)
- Topics: ai, chatgpt, commit, commit-message, diff, generate
- Language: TypeScript
- Homepage: https://genmoji.xyz
- Size: 751 KB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# genmoji
[Genmoji](https://genmoji.dev) is a tool that uses OpenAI's GPT or Anthropic's Claude API to generate commit messages from code snippets or `git diff`. With [Genmoji](https://genmoji.dev), developers can easily create informative and concise commit messages, using the [gitmoji](https://gitmoji.dev) standard, without spending time and effort writing them themselves.
## Install
Bring your own API key. You will need either an OpenAI or Anthropic API key exported as the environment variables `OPENAI_API_KEY` or `ANTHROPIC_API_KEY`.
```bash
# Install in the current directory
curl -sSL https://raw.githubusercontent.com/segersniels/genmoji/master/scripts/install.sh | bash
# Install in /usr/local/bin
curl -sSL https://raw.githubusercontent.com/segersniels/genmoji/master/scripts/install.sh | sudo bash -s /usr/local/bin
```
### Update
When an update is available, you will see a message in your terminal notifying you that a new version is available.
To update, run above install script again and you're good to go.
### Manual
1. Download the latest binary from the [releases](https://github.com/segersniels/genmoji/releases/latest) page for your system
2. Rename the binary to `genmoji`
3. Copy the binary to a location in your `$PATH`