git-acm - git auto-commit-message
generate meaningful commit messages locally using AI
acm (Auto Commit Messages) is a command-line tool that automatically generates descriptive commit messages by analyzing your git diff. It leverages the AI to provide intelligent and context-aware commit message suggestions.
some features are currently in progress. it's works with gemini-api rn. and available as pkg for your rust project. working on the binary release.
‼ keep in mind, this requirements must be met, i'm working on error handling so these things don't cause much problems. ty.
requirements
- you should have git installed initialised in the repo.
- stage the changes you want to commit.
- just run
acm
oracm run
.
if outputs the commit msg in the terminal if you like it > copy it > use it as commit msg.
todo
- get diff.
- get commit msg from api.
- make it a cli tool.
- publish to cargo as a pacakge.
- better error handling.
- supports openai, anthropic as well.
- github release.
- publish to brew or binary release.
maybe later -> a website for this project.
local development setup
ensure
rust
is installed on your system . go tohttps://doc.rust-lang.org/book/ch01-01-installation.html
for details.
-
- get an gemini-api key (currenlty only this supported) here.
- create
.env
file at root > setGEMINI_API_KEY=" "
. -
cargo run
to get the commit msg in the terminal.- start with
main.rs
and break stuff.
give your suggestions on what features i should add.
me : shivam.ing
bhai : sargam (project idea)