Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coder/aicommit
become the world's laziest committer
https://github.com/coder/aicommit
ai git
Last synced: about 10 hours ago
JSON representation
become the world's laziest committer
- Host: GitHub
- URL: https://github.com/coder/aicommit
- Owner: coder
- License: cc0-1.0
- Created: 2024-08-28T03:18:51.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T17:02:50.000Z (about 17 hours ago)
- Last Synced: 2024-11-06T18:18:32.781Z (about 16 hours ago)
- Topics: ai, git
- Language: Go
- Homepage:
- Size: 132 KB
- Stars: 134
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aicommit
`aicommit` is a small command line tool for generating commit messages. There
are many of these already out there, some even with the same name. But none
(to my knowledge) follow the repository's existing style, making
them useless when working in an established codebase.
A good commit message is more than a summary of the code changes. It contains
the intention, context, and external references that help others understand the
change. Thus, `aicommit` has a `-c`/`--context` flag for quickly adding
this detail.
`aicommit` is inspired by our good friend [@sreya](https://github.com/sreya):
## Install
Via Homebrew:
```
brew install aicommit
```
Or, using Go:
```
go install github.com/coder/aicommit/cmd/aicommit@main
```
Or, download a binary from [the latest release](https://github.com/coder/aicommit/releases).
## Usage
You can run `aicommit` with no arguments to generate a commit message for the
staged changes.
```bash
export OPENAI_API_KEY="..."
aicommit
```
You can "retry" a commit message by using the `-a`/`--amend` flag.
```bash
aicommit -a
```
You can dry-run with `-d`/`--dry` to see the ideal message without committing.
```bash
aicommit -d
```
Or, you can point to a specific ref:
```bash
aicommit HEAD~3
```
You can also provide context to the AI to help it generate a better commit message:
```bash
aicommit -c "closes #123"
aicommit -c "improved HTTP performance by 50%"
aicommit -c "bad code but need for urgent customer fix"
```
When tired of setting environment variables, you can save your key to disk:
```bash
export OPENAI_API_KEY="..."
aicommit --save-key
# The environment variable will override the saved key.
```
## Style Guide
`aicommit` will read the `COMMITS.md` file in the root of the repository to
determine the style guide. It is optional, but if it exists, it will be followed
even if the rules there diverge from the norm.
If there is no repo style guide, `aicommit` will look for a user style guide
in `~/COMMITS.md`.
## Other Providers
You may set `OPENAI_BASE_URL` to use other OpenAI compatible APIs with `aicommit`.
So far, I've tested it with [LiteLLM](https://github.com/BerriAI/litellm) across
local models (via ollama) and Anthropic. I have yet to find a local model
that is well-steered by the prompt design here, but the Anthropic Claude 3.5
commit messages are on par with 4o. My theory for why local models don't work well
is they (incl. "Instruct" models) have much worse instruction fine-tuning
than flagship commercial models.