soulcraft/brainy
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

feat(tools): add claude-commit AI-powered git commit tool

Browse source 
Implemented a comprehensive AI-powered commit message generator using Claude that:
- Automatically generates Conventional Commit formatted messages
- Analyzes git diff to create context-aware commit messages
- Works globally across all git repositories with 'git cc' command
- Supports multi-computer setup through portable dotfiles

Major changes:
- Added global claude-commit script with git aliases (git cc, git smart-commit)
- Created organized documentation in docs/tools/claude-commit/
- Included portable dotfiles structure for easy multi-machine deployment
- Updated README with TLDR Node.js quickstart section featuring all Brainy capabilities
- Moved documentation section to bottom of README for better flow
- Added CLAUDE.md with project-specific instructions for Claude Code

The tool eliminates manual commit message writing by leveraging AI to understand
code changes and generate properly formatted, meaningful commit messages that
follow the Conventional Commits specification.
This commit is contained in:
David Snelling 2025-08-04 10:14:33 -07:00
parent ab0ee4d4ad
commit d2cef55644
10 changed files with 1565 additions and 1797 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.github/git-commit-instructions.md vendored
View file

@ -1,3 +0,0 @@
Use Conventional Commit format
Specify the changes in a structured format
Add information about the purpose of the commit

1
.gitignore vendored
View file

@ -70,4 +70,3 @@ debug*.ts
/temp/
/temp-tests/
/brainy-models-package/node_modules/
/CLAUDE.md

2457
README.md
View file

File diff suppressed because it is too large Load diff

128
docs/tools/claude-commit/README.md Normal file
View file

@ -0,0 +1,128 @@
# Claude Commit - AI-Powered Git Commits
Automatically generate Conventional Commit messages using Claude AI by analyzing your git diff.
## 🚀 Quick Setup
### One-Line Install (Simplest)
On any computer, just run:
```bash
# Download and run the setup script
curl -sSL https://raw.githubusercontent.com/soulcraft-research/brainy/main/docs/tools/claude-commit/setup.sh | bash
```
### Manual Install
If you have the brainy repo cloned:
```bash
cd ~/Projects/brainy/docs/tools/claude-commit
./setup.sh
```
### Using Dotfiles (For Multiple Machines)
1. **First time:** Create your dotfiles repository
```bash
# Copy the dotfiles folder from brainy to a new repo
cp -r ~/Projects/brainy/docs/tools/claude-commit/dotfiles ~/Projects/my-dotfiles
cd ~/Projects/my-dotfiles
git init
git add .
git commit -m "feat: add claude-commit dotfiles"
# Create a GitHub repo and push
```
2. **On any new computer:**
```bash
# One-line install from your dotfiles
curl -sSL https://raw.githubusercontent.com/yourusername/my-dotfiles/main/install.sh | bash
```
## 📁 What Gets Installed
- `~/.local/bin/claude-commit` - The main script
- Git aliases: `git cc` and `git smart-commit`
- PATH update (if needed)
## 🔄 Keeping Computers in Sync
### Manual Sync
On any computer, update to latest version:
```bash
# From brainy repo
curl -sSL https://raw.githubusercontent.com/yourusername/brainy/main/dotfiles/bin/claude-commit > ~/.local/bin/claude-commit
chmod +x ~/.local/bin/claude-commit
```
### Automatic Sync with Dotfiles
If you set up a dotfiles repo:
```bash
cd ~/Projects/my-dotfiles
git pull
./install.sh
```
## 💻 Per-Computer Setup Checklist
When setting up a new computer:
- [ ] Install Claude CLI (`claude` command must work)
- [ ] Run the setup script
- [ ] Restart terminal or `source ~/.bashrc`
- [ ] Test with `git cc` in any repo
## 🧪 Testing
After setup, test in any git repository:
```bash
# Make a change to any file
echo "test" >> README.md
# Use claude to commit
git cc
```
## 🔧 Troubleshooting
### "command not found: claude"
- Install Claude CLI from https://claude.ai/code
### "command not found: git cc"
- Run: `source ~/.bashrc` (or `~/.zshrc` for Zsh)
- Verify: `ls -la ~/.local/bin/claude-commit`
### Script not generating commits
- Check Claude CLI works: `claude --version`
- Ensure you have changes: `git status`
## 📝 Files in This Setup
```
brainy/
├── setup-claude-commit.sh # Standalone installer
├── CLAUDE_COMMIT_SETUP.md # This file
└── dotfiles/ # Portable dotfiles
├── README.md # Dotfiles documentation
├── install.sh # Master installer
├── setup-claude-commit.sh # Claude commit installer
└── bin/
└── claude-commit # The actual script
```
## 🎯 Summary
**For your laptop**, you have three options:
1. **Quickest:** Run the setup script from brainy repo
2. **Portable:** Create a dotfiles repo and install from there
3. **Manual:** Copy the script directly to `~/.local/bin/`
All methods give you the same `git cc` command that works in any git repository!

121
docs/tools/claude-commit/dotfiles/README.md Normal file
View file

@ -0,0 +1,121 @@
# Dotfiles - Claude Commit Setup
This repository contains my development environment configuration, including the Claude AI-powered git commit message generator.
## Quick Setup
### Option 1: One-Line Install (Recommended)
```bash
curl -sSL https://raw.githubusercontent.com/yourusername/dotfiles/main/install.sh | bash
```
### Option 2: Manual Install
```bash
# Clone the repository
git clone https://github.com/yourusername/dotfiles.git ~/dotfiles
# Run the setup script
cd ~/dotfiles
./install.sh
```
### Option 3: Just Claude Commit
If you only want the `git cc` command:
```bash
# Download and run the setup script
curl -sSL https://raw.githubusercontent.com/yourusername/dotfiles/main/setup-claude-commit.sh | bash
```
## What's Included
### Claude Commit (`git cc`)
An AI-powered git commit message generator that:
- Analyzes your git diff
- Generates Conventional Commit formatted messages
- Works in any git repository
- No configuration needed
**Usage:**
```bash
# Make your changes
git cc # Claude generates the commit message
```
## Syncing Between Computers
### First Time Setup (on new computer)
1. Run the install script (see Quick Setup above)
2. That's it! The `git cc` command is now available
### Keeping in Sync
To update to the latest version on any computer:
```bash
sync-claude-commit
```
Or manually:
```bash
curl -sSL https://raw.githubusercontent.com/yourusername/dotfiles/main/bin/claude-commit > ~/.local/bin/claude-commit
chmod +x ~/.local/bin/claude-commit
```
## File Structure
```
dotfiles/
├── README.md # This file
├── install.sh # Main installation script
├── setup-claude-commit.sh # Standalone claude-commit installer
└── bin/
└── claude-commit # The actual claude-commit script
```
## Requirements
- Git
- Claude CLI (`claude` command)
- Bash or Zsh
## Conventional Commit Format
The tool generates messages following this format:
```
<type>(<scope>): <description>
<body>
<footer>
```
**Types:** `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`
## Troubleshooting
### "claude: command not found"
Make sure Claude CLI is installed:
```bash
# Install Claude CLI if not present
# Visit: https://claude.ai/code
```
### "git cc: command not found"
Make sure ~/.local/bin is in your PATH:
```bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
```
## License
MIT

131
docs/tools/claude-commit/dotfiles/bin/claude-commit Executable file
View file

@ -0,0 +1,131 @@
#!/bin/bash
# Claude Commit Message Generator - Global Version
# Automatically generates Conventional Commit messages using git diff
# Colors for output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m' # No Color
# Check if we're in a git repository
if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
echo -e "${RED}Not in a git repository${NC}"
exit 1
fi
# Check if there are changes to commit
if [[ -z $(git status -s) ]]; then
echo -e "${RED}No changes to commit${NC}"
exit 1
fi
# Get the diff of staged changes (or all changes if nothing staged)
if [[ -n $(git diff --cached --name-only) ]]; then
DIFF=$(git diff --cached)
FILES=$(git diff --cached --name-only)
echo -e "${GREEN}Analyzing staged changes...${NC}"
else
DIFF=$(git diff)
FILES=$(git diff --name-only)
echo -e "${YELLOW}No staged changes. Analyzing all modified files...${NC}"
echo -e "${YELLOW}Run 'git add' first to stage specific changes${NC}"
fi
# Get project name from git remote or directory name
PROJECT_NAME=$(basename "$(git rev-parse --show-toplevel)")
REMOTE_URL=$(git config --get remote.origin.url 2>/dev/null)
if [[ -n "$REMOTE_URL" ]]; then
PROJECT_NAME=$(basename -s .git "$REMOTE_URL")
fi
# Create a prompt for Claude
PROMPT="Based on the following git diff from the '$PROJECT_NAME' project, generate a Conventional Commit message.
REQUIREMENTS:
1. Use Conventional Commit format: <type>(<scope>): <description>
2. Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore
3. Keep first line under 72 characters
4. Use imperative mood (e.g., 'add' not 'added')
5. Include a detailed body explaining the purpose and impact
6. Note any breaking changes with 'BREAKING CHANGE:' prefix
7. Reference any issue numbers if apparent from the code
FILES CHANGED:
$FILES
GIT DIFF (showing first 500 lines):
$(echo "$DIFF" | head -n 500)
Generate ONLY the commit message, no explanations or markdown formatting."
# Call Claude API (using claude CLI)
echo -e "${GREEN}Generating commit message with Claude...${NC}"
# Save the prompt to a temporary file to avoid shell escaping issues
TEMP_PROMPT=$(mktemp)
echo "$PROMPT" > "$TEMP_PROMPT"
# Generate the commit message
COMMIT_MSG=$(claude code --no-markdown < "$TEMP_PROMPT" 2>/dev/null)
# Clean up temp file
rm "$TEMP_PROMPT"
# Check if message was generated
if [[ -z "$COMMIT_MSG" ]]; then
echo -e "${RED}Failed to generate commit message${NC}"
echo "Falling back to standard git commit..."
git commit
exit 1
fi
# Display the generated message
echo -e "${GREEN}Generated commit message:${NC}"
echo "----------------------------------------"
echo "$COMMIT_MSG"
echo "----------------------------------------"
# Ask for confirmation
echo -e "${YELLOW}Do you want to:${NC}"
echo " 1) Use this message"
echo " 2) Edit this message"
echo " 3) Cancel"
read -p "Choice [1-3]: " choice
case $choice in
1)
# Stage all changes if nothing is staged
if [[ -z $(git diff --cached --name-only) ]]; then
git add -A
fi
# Commit with the generated message
git commit -m "$COMMIT_MSG"
echo -e "${GREEN}✓ Committed successfully${NC}"
;;
2)
# Save message to temp file and open in editor
TEMP_MSG=$(mktemp)
echo "$COMMIT_MSG" > "$TEMP_MSG"
${EDITOR:-vim} "$TEMP_MSG"
# Stage all changes if nothing is staged
if [[ -z $(git diff --cached --name-only) ]]; then
git add -A
fi
# Commit with edited message
git commit -F "$TEMP_MSG"
rm "$TEMP_MSG"
echo -e "${GREEN}✓ Committed with edited message${NC}"
;;
3)
echo -e "${YELLOW}Commit cancelled${NC}"
exit 0
;;
*)
echo -e "${RED}Invalid choice. Commit cancelled${NC}"
exit 1
;;
esac

67
docs/tools/claude-commit/dotfiles/install.sh Executable file
View file

@ -0,0 +1,67 @@
#!/bin/bash
# Master installation script for dotfiles
# This installs all dotfiles including claude-commit
set -e
# Colors
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
NC='\033[0m'
echo -e "${BLUE}==================================${NC}"
echo -e "${BLUE} Dotfiles Installation${NC}"
echo -e "${BLUE}==================================${NC}"
echo ""
# Get the directory of this script
if [[ -n "$BASH_SOURCE" ]]; then
DOTFILES_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
else
# Fallback for when script is piped from curl
DOTFILES_DIR="$HOME/dotfiles"
# Clone the repository if it doesn't exist
if [[ ! -d "$DOTFILES_DIR" ]]; then
echo -e "${YELLOW}Cloning dotfiles repository...${NC}"
git clone https://github.com/yourusername/dotfiles.git "$DOTFILES_DIR"
fi
fi
# Install claude-commit
echo -e "${YELLOW}Installing claude-commit...${NC}"
if [[ -f "$DOTFILES_DIR/setup-claude-commit.sh" ]]; then
bash "$DOTFILES_DIR/setup-claude-commit.sh"
elif [[ -f "$DOTFILES_DIR/bin/claude-commit" ]]; then
# Direct installation from bin directory
mkdir -p ~/.local/bin
cp "$DOTFILES_DIR/bin/claude-commit" ~/.local/bin/
chmod +x ~/.local/bin/claude-commit
# Set up git aliases
git config --global alias.cc '!~/.local/bin/claude-commit'
git config --global alias.smart-commit '!~/.local/bin/claude-commit'
echo -e "${GREEN}✓ claude-commit installed${NC}"
else
echo -e "${RED}✗ claude-commit script not found${NC}"
fi
# Add more dotfiles installations here as needed
# For example:
# echo -e "${YELLOW}Installing vim configuration...${NC}"
# ln -sf "$DOTFILES_DIR/vimrc" ~/.vimrc
echo ""
echo -e "${GREEN}==================================${NC}"
echo -e "${GREEN} Installation Complete!${NC}"
echo -e "${GREEN}==================================${NC}"
echo ""
echo -e "${BLUE}Installed tools:${NC}"
echo -e " • git cc (claude-commit)"
echo ""
echo -e "${YELLOW}Please restart your terminal or run:${NC}"
echo -e " source ~/.bashrc (or ~/.zshrc for Zsh)"

237
docs/tools/claude-commit/dotfiles/setup-claude-commit.sh Executable file
View file

@ -0,0 +1,237 @@
#!/bin/bash
# Setup script for Claude Commit on any machine
# This script installs the claude-commit tool globally
set -e
# Colors for output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
NC='\033[0m' # No Color
echo -e "${BLUE}==================================${NC}"
echo -e "${BLUE} Claude Commit Setup Script${NC}"
echo -e "${BLUE}==================================${NC}"
echo ""
# Create ~/.local/bin if it doesn't exist
echo -e "${YELLOW}Creating ~/.local/bin directory...${NC}"
mkdir -p ~/.local/bin
# Create the claude-commit script
echo -e "${YELLOW}Installing claude-commit script...${NC}"
cat > ~/.local/bin/claude-commit << 'EOF'
#!/bin/bash
# Claude Commit Message Generator - Global Version
# Automatically generates Conventional Commit messages using git diff
# Colors for output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m' # No Color
# Check if we're in a git repository
if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
echo -e "${RED}Not in a git repository${NC}"
exit 1
fi
# Check if there are changes to commit
if [[ -z $(git status -s) ]]; then
echo -e "${RED}No changes to commit${NC}"
exit 1
fi
# Get the diff of staged changes (or all changes if nothing staged)
if [[ -n $(git diff --cached --name-only) ]]; then
DIFF=$(git diff --cached)
FILES=$(git diff --cached --name-only)
echo -e "${GREEN}Analyzing staged changes...${NC}"
else
DIFF=$(git diff)
FILES=$(git diff --name-only)
echo -e "${YELLOW}No staged changes. Analyzing all modified files...${NC}"
echo -e "${YELLOW}Run 'git add' first to stage specific changes${NC}"
fi
# Get project name from git remote or directory name
PROJECT_NAME=$(basename "$(git rev-parse --show-toplevel)")
REMOTE_URL=$(git config --get remote.origin.url 2>/dev/null)
if [[ -n "$REMOTE_URL" ]]; then
PROJECT_NAME=$(basename -s .git "$REMOTE_URL")
fi
# Create a prompt for Claude
PROMPT="Based on the following git diff from the '$PROJECT_NAME' project, generate a Conventional Commit message.
REQUIREMENTS:
1. Use Conventional Commit format: <type>(<scope>): <description>
2. Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore
3. Keep first line under 72 characters
4. Use imperative mood (e.g., 'add' not 'added')
5. Include a detailed body explaining the purpose and impact
6. Note any breaking changes with 'BREAKING CHANGE:' prefix
7. Reference any issue numbers if apparent from the code
FILES CHANGED:
$FILES
GIT DIFF (showing first 500 lines):
$(echo "$DIFF" | head -n 500)
Generate ONLY the commit message, no explanations or markdown formatting."
# Call Claude API (using claude CLI)
echo -e "${GREEN}Generating commit message with Claude...${NC}"
# Save the prompt to a temporary file to avoid shell escaping issues
TEMP_PROMPT=$(mktemp)
echo "$PROMPT" > "$TEMP_PROMPT"
# Generate the commit message
COMMIT_MSG=$(claude code --no-markdown < "$TEMP_PROMPT" 2>/dev/null)
# Clean up temp file
rm "$TEMP_PROMPT"
# Check if message was generated
if [[ -z "$COMMIT_MSG" ]]; then
echo -e "${RED}Failed to generate commit message${NC}"
echo "Falling back to standard git commit..."
git commit
exit 1
fi
# Display the generated message
echo -e "${GREEN}Generated commit message:${NC}"
echo "----------------------------------------"
echo "$COMMIT_MSG"
echo "----------------------------------------"
# Ask for confirmation
echo -e "${YELLOW}Do you want to:${NC}"
echo " 1) Use this message"
echo " 2) Edit this message"
echo " 3) Cancel"
read -p "Choice [1-3]: " choice
case $choice in
1)
# Stage all changes if nothing is staged
if [[ -z $(git diff --cached --name-only) ]]; then
git add -A
fi
# Commit with the generated message
git commit -m "$COMMIT_MSG"
echo -e "${GREEN}✓ Committed successfully${NC}"
;;
2)
# Save message to temp file and open in editor
TEMP_MSG=$(mktemp)
echo "$COMMIT_MSG" > "$TEMP_MSG"
${EDITOR:-vim} "$TEMP_MSG"
# Stage all changes if nothing is staged
if [[ -z $(git diff --cached --name-only) ]]; then
git add -A
fi
# Commit with edited message
git commit -F "$TEMP_MSG"
rm "$TEMP_MSG"
echo -e "${GREEN}✓ Committed with edited message${NC}"
;;
3)
echo -e "${YELLOW}Commit cancelled${NC}"
exit 0
;;
*)
echo -e "${RED}Invalid choice. Commit cancelled${NC}"
exit 1
;;
esac
EOF
# Make the script executable
chmod +x ~/.local/bin/claude-commit
echo -e "${GREEN}✓ claude-commit script installed${NC}"
# Set up git aliases
echo -e "${YELLOW}Setting up git aliases...${NC}"
git config --global alias.cc '!~/.local/bin/claude-commit'
git config --global alias.smart-commit '!~/.local/bin/claude-commit'
echo -e "${GREEN}✓ Git aliases configured${NC}"
# Add ~/.local/bin to PATH if not already there
if [[ ":$PATH:" != *":$HOME/.local/bin:"* ]]; then
echo -e "${YELLOW}Adding ~/.local/bin to PATH...${NC}"
# Detect shell and update appropriate config file
if [[ -n "$ZSH_VERSION" ]]; then
SHELL_CONFIG="$HOME/.zshrc"
elif [[ -n "$BASH_VERSION" ]]; then
SHELL_CONFIG="$HOME/.bashrc"
else
SHELL_CONFIG="$HOME/.profile"
fi
echo '' >> "$SHELL_CONFIG"
echo '# Added by claude-commit setup' >> "$SHELL_CONFIG"
echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$SHELL_CONFIG"
echo -e "${GREEN}✓ Added to $SHELL_CONFIG${NC}"
echo -e "${YELLOW}Please run: source $SHELL_CONFIG${NC}"
else
echo -e "${GREEN}✓ ~/.local/bin already in PATH${NC}"
fi
# Test the installation
echo ""
echo -e "${BLUE}Testing installation...${NC}"
if command -v claude-commit >/dev/null 2>&1 || [ -x ~/.local/bin/claude-commit ]; then
echo -e "${GREEN}✓ claude-commit is installed and executable${NC}"
else
echo -e "${YELLOW}⚠ claude-commit installed but not in PATH yet${NC}"
echo -e "${YELLOW} Please restart your terminal or run: source ~/.bashrc${NC}"
fi
if git config --global --get alias.cc >/dev/null 2>&1; then
echo -e "${GREEN}✓ git cc alias is configured${NC}"
else
echo -e "${RED}✗ git cc alias configuration failed${NC}"
fi
echo ""
echo -e "${GREEN}==================================${NC}"
echo -e "${GREEN} Installation Complete!${NC}"
echo -e "${GREEN}==================================${NC}"
echo ""
echo -e "${BLUE}Usage:${NC}"
echo -e " ${YELLOW}git cc${NC} - Generate and commit with Claude"
echo -e " ${YELLOW}git smart-commit${NC} - Alternative alias"
echo ""
echo -e "${BLUE}This works in any git repository!${NC}"
echo ""
# Create a sync script for dotfiles
echo -e "${YELLOW}Creating sync script...${NC}"
cat > ~/.local/bin/sync-claude-commit << 'SYNC_EOF'
#!/bin/bash
# Sync claude-commit from a remote source
SCRIPT_URL="https://raw.githubusercontent.com/yourusername/dotfiles/main/bin/claude-commit"
echo "Syncing claude-commit..."
curl -sSL "$SCRIPT_URL" > ~/.local/bin/claude-commit
chmod +x ~/.local/bin/claude-commit
echo "✓ claude-commit updated"
SYNC_EOF
chmod +x ~/.local/bin/sync-claude-commit
echo -e "${GREEN}✓ Sync script created at ~/.local/bin/sync-claude-commit${NC}"
echo -e "${YELLOW} (Update the URL in the script to your dotfiles repo)${NC}"

202
docs/tools/claude-commit/setup.sh Executable file
View file

@ -0,0 +1,202 @@
#!/bin/bash
# Setup script for Claude Commit on any machine
# This script installs the claude-commit tool globally
set -e
# Colors for output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
NC='\033[0m' # No Color
echo -e "${BLUE}==================================${NC}"
echo -e "${BLUE} Claude Commit Setup Script${NC}"
echo -e "${BLUE}==================================${NC}"
echo ""
# Create ~/.local/bin if it doesn't exist
echo -e "${YELLOW}Creating ~/.local/bin directory...${NC}"
mkdir -p ~/.local/bin
# Create the claude-commit script
echo -e "${YELLOW}Installing claude-commit script...${NC}"
cat > ~/.local/bin/claude-commit << 'EOF'
#!/bin/bash
# Claude Commit Message Generator - Global Version
# Automatically generates Conventional Commit messages using git diff
# Colors for output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m' # No Color
# Check if we're in a git repository
if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
echo -e "${RED}Not in a git repository${NC}"
exit 1
fi
# Check if there are changes to commit
if [[ -z $(git status -s) ]]; then
echo -e "${RED}No changes to commit${NC}"
exit 1
fi
# Get the diff of staged changes (or all changes if nothing staged)
if [[ -n $(git diff --cached --name-only) ]]; then
DIFF=$(git diff --cached)
FILES=$(git diff --cached --name-only)
echo -e "${GREEN}Analyzing staged changes...${NC}"
else
DIFF=$(git diff)
FILES=$(git diff --name-only)
echo -e "${YELLOW}No staged changes. Analyzing all modified files...${NC}"
echo -e "${YELLOW}Run 'git add' first to stage specific changes${NC}"
fi
# Get project name from git remote or directory name
PROJECT_NAME=$(basename "$(git rev-parse --show-toplevel)")
REMOTE_URL=$(git config --get remote.origin.url 2>/dev/null)
if [[ -n "$REMOTE_URL" ]]; then
PROJECT_NAME=$(basename -s .git "$REMOTE_URL")
fi
# Create a prompt for Claude
PROMPT="Based on the following git diff from the '$PROJECT_NAME' project, generate a Conventional Commit message.
REQUIREMENTS:
1. Use Conventional Commit format: <type>(<scope>): <description>
2. Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore
3. Keep first line under 72 characters
4. Use imperative mood (e.g., 'add' not 'added')
5. Include a detailed body explaining the purpose and impact
6. Note any breaking changes with 'BREAKING CHANGE:' prefix
7. Reference any issue numbers if apparent from the code
FILES CHANGED:
$FILES
GIT DIFF (showing first 500 lines):
$(echo "$DIFF" | head -n 500)
Generate ONLY the commit message, no explanations or markdown formatting."
# Call Claude API (using claude CLI)
echo -e "${GREEN}Generating commit message with Claude...${NC}"
# Save the prompt to a temporary file to avoid shell escaping issues
TEMP_PROMPT=$(mktemp)
echo "$PROMPT" > "$TEMP_PROMPT"
# Generate the commit message
COMMIT_MSG=$(claude code --no-markdown < "$TEMP_PROMPT" 2>/dev/null)
# Clean up temp file
rm "$TEMP_PROMPT"
# Check if message was generated
if [[ -z "$COMMIT_MSG" ]]; then
echo -e "${RED}Failed to generate commit message${NC}"
echo "Falling back to standard git commit..."
git commit
exit 1
fi
# Display the generated message
echo -e "${GREEN}Generated commit message:${NC}"
echo "----------------------------------------"
echo "$COMMIT_MSG"
echo "----------------------------------------"
# Ask for confirmation
echo -e "${YELLOW}Do you want to:${NC}"
echo " 1) Use this message"
echo " 2) Edit this message"
echo " 3) Cancel"
read -p "Choice [1-3]: " choice
case $choice in
1)
# Stage all changes if nothing is staged
if [[ -z $(git diff --cached --name-only) ]]; then
git add -A
fi
# Commit with the generated message
git commit -m "$COMMIT_MSG"
echo -e "${GREEN}✓ Committed successfully${NC}"
;;
2)
# Save message to temp file and open in editor
TEMP_MSG=$(mktemp)
echo "$COMMIT_MSG" > "$TEMP_MSG"
${EDITOR:-vim} "$TEMP_MSG"
# Stage all changes if nothing is staged
if [[ -z $(git diff --cached --name-only) ]]; then
git add -A
fi
# Commit with edited message
git commit -F "$TEMP_MSG"
rm "$TEMP_MSG"
echo -e "${GREEN}✓ Committed with edited message${NC}"
;;
3)
echo -e "${YELLOW}Commit cancelled${NC}"
exit 0
;;
*)
echo -e "${RED}Invalid choice. Commit cancelled${NC}"
exit 1
;;
esac
EOF
# Make the script executable
chmod +x ~/.local/bin/claude-commit
echo -e "${GREEN}✓ claude-commit script installed${NC}"
# Set up git aliases
echo -e "${YELLOW}Setting up git aliases...${NC}"
git config --global alias.cc '!~/.local/bin/claude-commit'
git config --global alias.smart-commit '!~/.local/bin/claude-commit'
echo -e "${GREEN}✓ Git aliases configured${NC}"
# Add ~/.local/bin to PATH if not already there
if [[ ":$PATH:" != *":$HOME/.local/bin:"* ]]; then
echo -e "${YELLOW}Adding ~/.local/bin to PATH...${NC}"
# Detect shell and update appropriate config file
if [[ -n "$ZSH_VERSION" ]]; then
SHELL_CONFIG="$HOME/.zshrc"
elif [[ -n "$BASH_VERSION" ]]; then
SHELL_CONFIG="$HOME/.bashrc"
else
SHELL_CONFIG="$HOME/.profile"
fi
echo '' >> "$SHELL_CONFIG"
echo '# Added by claude-commit setup' >> "$SHELL_CONFIG"
echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$SHELL_CONFIG"
echo -e "${GREEN}✓ Added to $SHELL_CONFIG${NC}"
echo -e "${YELLOW}Please run: source $SHELL_CONFIG${NC}"
else
echo -e "${GREEN}✓ ~/.local/bin already in PATH${NC}"
fi
echo ""
echo -e "${GREEN}==================================${NC}"
echo -e "${GREEN} Installation Complete!${NC}"
echo -e "${GREEN}==================================${NC}"
echo ""
echo -e "${BLUE}Usage:${NC}"
echo -e " ${YELLOW}git cc${NC} - Generate and commit with Claude"
echo -e " ${YELLOW}git smart-commit${NC} - Alternative alias"
echo ""
echo -e "${BLUE}This works in any git repository!${NC}"

15
scripts/claude-commit.sh Executable file
View file

@ -0,0 +1,15 @@
#!/bin/bash
# This script now calls the global claude-commit command
# The global version is located at ~/.local/bin/claude-commit
# Or can be installed from docs/tools/claude-commit/setup.sh
if command -v claude-commit >/dev/null 2>&1; then
exec claude-commit "$@"
elif [ -x "$HOME/.local/bin/claude-commit" ]; then
exec "$HOME/.local/bin/claude-commit" "$@"
else
echo "claude-commit not found. Please run:"
echo " ./docs/tools/claude-commit/setup.sh"
exit 1
fi