docs 📄 : git-acm.pages.dev | crate 🦀 : crates.io
curl -sSL https://raw.githubusercontent.com/shivamhwp/git-acm/main/install.sh | sh
to update : just run the installation command, it checks the system for prev version and then installs a new version if there's one.
or
if you have cargo
installed on your system.
cargo install git-acm
- ensure git is initialized in the dir. or run
git init
. - add gemini-api-key or openai-api-key or anthropic-api-key or deepseek-api-key
- add these in your project's
.env
file (preferred) orexport
them in terminal.
# for gemini api
GEMINI_API_KEY=""
# for anthropic api
ANTHROPIC_API_KEY=""
# for openai api
OPENAI_API_KEY=""
# for llama api (using ollama)
LLAMA_API_URL="http://localhost:11434/api/generate"
LLAMA_MODEL_NAME= "llama3.2:1b"
# for deepseek api
DEEPSEEEK_API_KEY=""
- run
git-acm use <model_name>
. - just run
git-acm
.
use
: choose which model you want to use. (run git-acm list
to see the available models).
autocommit
: enables or disables the autocommit functionality.
list
: lists all available models.
git-acm use <model_name> # choose which model to use.
git-acm autocommit enable # Enable automatic commits with generated messages
git-acm list # lists all the available models.
git-acm autocommit disable # Disable automatic commits
git-acm # Generate a commit message using the currently selected model.
ensure
rust
is installed on your system . go tohttps://doc.rust-lang.org/book/ch01-01-installation.html
for details.
-
git clone https://github.com/shivamhwp/acm.git
-
get gemini-api-credentials or openai-api-credentials or anthropic-api-credentials. see .env.example
-
create
.env
file at root > setGEMINI_API_KEY=" "
or any other provider's key. -
cargo build
-
cargo run --
to get the commit msg in the terminal. -
start with
main.rs
and break stuff.
bhai(s) : sargam (idea) and smr (suggestions).