Skip to content

Instantly share code, notes, and snippets.

@vlameiras
Forked from karpathy/add_to_zshrc.sh
Last active August 27, 2024 18:44
Show Gist options
  • Save vlameiras/8591bf75990571f5f1e2ea9c452047c3 to your computer and use it in GitHub Desktop.
Save vlameiras/8591bf75990571f5f1e2ea9c452047c3 to your computer and use it in GitHub Desktop.
Git Commit Message AI
# -----------------------------------------------------------------------------
# AI-powered Git Commit Function
# Copy paste this gist into your ~/.bashrc or ~/.zshrc to gain the `gai` command. It:
# 1) checks if there are any staged changes
# 2) gets the current staged changed diff
# 3) sends them to an LLM to write the git commit message
# 4) allows you to easily accept, edit, regenerate, cancel
# But - just read and edit the code however you like
# the `llm` CLI util is awesome, can get it here: https://llm.datasette.io/en/stable/
# Changes from original:
# - Renamed `gcm` to `gai` so it doesn't conflict with the Oh My ZSH alias
# - The script exits if there are no staged changes, preventing unnecessary API calls
# - Added clear user feedback when no staged changes are found
gai() {
# Check if there are any staged changes
if [ -z "$(git diff --cached --name-only)" ]; then
echo "No staged changes found. Please stage your changes before committing."
return 1
fi
# Function to generate commit message
generate_commit_message() {
git diff --cached | llm "
Below is a diff of all staged changes, coming from the command:
\`\`\`
git diff --cached
\`\`\`
Please generate a concise, one-line commit message for these changes."
}
# Function to read user input compatibly with both Bash and Zsh
read_input() {
if [ -n "$ZSH_VERSION" ]; then
echo -n "$1"
read -r REPLY
else
read -p "$1" -r REPLY
fi
}
# Main script
echo "Generating AI-powered commit message..."
commit_message=$(generate_commit_message)
while true; do
echo -e "\nProposed commit message:"
echo "$commit_message"
read_input "Do you want to (a)ccept, (e)dit, (r)egenerate, or (c)ancel? "
choice=$REPLY
case "$choice" in
a|A )
if git commit -m "$commit_message"; then
echo "Changes committed successfully!"
return 0
else
echo "Commit failed. Please check your changes and try again."
return 1
fi
;;
e|E )
read_input "Enter your commit message: "
commit_message=$REPLY
if [ -n "$commit_message" ] && git commit -m "$commit_message"; then
echo "Changes committed successfully with your message!"
return 0
else
echo "Commit failed. Please check your message and try again."
return 1
fi
;;
r|R )
echo "Regenerating commit message..."
commit_message=$(generate_commit_message)
;;
c|C )
echo "Commit cancelled."
return 1
;;
* )
echo "Invalid choice. Please try again."
;;
esac
done
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment