https://github.com/marclove/llmc
AI-powered commit message generator that follows Conventional Commits specification. Simply run npx llmc and it will automatically generate a commit message from your staged changes and commit them for you
https://github.com/marclove/llmc
claude claude-code cline codex-cli conventional-commit conventional-commits copilot cursor gemini-cli llm windsurf
Last synced: 6 months ago
JSON representation
AI-powered commit message generator that follows Conventional Commits specification. Simply run npx llmc and it will automatically generate a commit message from your staged changes and commit them for you
- Host: GitHub
- URL: https://github.com/marclove/llmc
- Owner: marclove
- License: bsd-3-clause
- Created: 2025-07-03T16:08:38.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-08-25T14:05:54.000Z (6 months ago)
- Last Synced: 2025-08-27T01:03:51.991Z (6 months ago)
- Topics: claude, claude-code, cline, codex-cli, conventional-commit, conventional-commits, copilot, cursor, gemini-cli, llm, windsurf
- Language: TypeScript
- Homepage:
- Size: 2.06 MB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# llmc
AI-powered commit message generator that follows Conventional Commits specification. Simply run `npx llmc` and it will automatically generate a commit message from your staged changes and commit them for you.
## Features
- 🤖 AI-generated commit messages using multiple providers (Anthropic, OpenAI, Google, etc.)
- 📝 Follows [Conventional Commits](https://www.conventionalcommits.org/) specification
- ⚙️ Configurable via TOML file with custom prompts
- 🔄 Automatic retry logic with visual progress indicators
- 🎨 Rich terminal UI with real-time status updates and timers
- 🚀 Zero-config usage with sensible defaults
- ✨ Automatically commits your changes after generating the message
- 🔗 Git hook integration with message-only mode
## Quick Start
### Using npx (Recommended)
```bash
# Initialize a configuration file (optional)
npx llmc init
# Stage your changes
git add .
# Generate commit message and commit automatically
npx llmc
# Or just generate the message without committing (for git hooks)
npx llmc --message-only
# Check version
npx llmc -v
# Show help
npx llmc -h
```
That's it! llmc will:
1. ✅ Check for staged changes
2. 🤖 Generate a commit message using AI
3. 📝 Commit your changes with the generated message
4. 🎉 Show you the result with a beautiful progress interface
### Installation
```bash
npm install -g llmc
```
## Configuration
To configure llmc, you can create a `llmc.toml` file in your project root. The easiest way to get started is to run the `init` command:
```bash
npx llmc init
```
This will create a `llmc.toml` file with the default settings, which you can then customize.
Here's an example of a `llmc.toml` file:
```toml
provider = "anthropic"
model = "claude-sonnet-4-20250514"
max_tokens = 250
temperature = 1.0
api_key_name = "ANTHROPIC_API_KEY"
# Optional: Custom prompt with ${diff} interpolation
prompt = """
Analyze this git diff and generate a commit message following Conventional Commits.
Git diff:
${diff}
Provide a clear, concise commit message.
"""
```
### Supported Providers
- `anthropic` - Claude models (default)
- `openai` - GPT models
- `google` - Gemini models
- `groq` - Fast inference
- `cerebras` - High-performance models
- `cohere` - Command models
- `deepseek` - DeepSeek models
- `mistral` - Mistral models
- `perplexity` - Perplexity models
- `replicate` - Replicate models
- `togetherai` - Together AI models
- `vercel` - Vercel AI models
- `xai` - xAI models
### Environment Variables
Set the appropriate API key for your chosen provider:
```bash
export ANTHROPIC_API_KEY="your-api-key"
export OPENAI_API_KEY="your-api-key"
export GOOGLE_API_KEY="your-api-key"
# ... etc
```
## Git Hook Integration
For git hook integration, use the `--message-only` or `--no-commit` flags to generate commit messages without automatically committing:
```bash
npx llmc --message-only
npx llmc --no-commit # Same as --message-only
```
### prepare-commit-msg Hook Setup
Create `.git/hooks/prepare-commit-msg`:
```bash
#!/bin/sh
# Generate commit message using llmc
npx llmc --message-only > "$1"
```
Make it executable:
```bash
chmod +x .git/hooks/prepare-commit-msg
```
Now when you run `git commit`, llmc will automatically generate the commit message for you.
### commit-msg Hook Setup
For validation and generation combined:
```bash
#!/bin/sh
# Generate commit message if none provided
if [ -z "$(cat $1 | grep -v '^#')" ]; then
npx llmc --message-only > "$1"
fi
```
## Usage Examples
### Basic Usage
```bash
# Stage your changes
git add .
# Generate commit message and commit automatically
npx llmc
# Generate message only (for git hooks)
npx llmc --message-only
```
### Custom Configuration
```bash
# Use different provider
echo 'provider = "openai"' > llmc.toml
npx llmc
# Use custom prompt
cat > llmc.toml << EOF
provider = "anthropic"
prompt = """
Create a commit message for this diff: \${diff}
Make it concise and professional.
"""
EOF
npx llmc
```
### Example Output
When you run `npx llmc`, you'll see a beautiful progress interface:
```
⠋ Checking for staged changes...
⠋ Generating commit message...
Time elapsed: 2s
⠋ Committing changes...
✓ Committed successfully!
Commit message: feat(components): add new Button component with accessibility features
```
## Development
### Building and Testing
```bash
# Install dependencies
npm install
# Format code
npm run format
# Build the project (includes formatting)
npm run build
# Run tests (excludes API integration tests)
npm test
# Run tests in watch mode
npm run test:watch
# Run API integration tests (requires valid API key)
npm run test:integration
# Run all tests (including API integration tests)
npm run test:all
# Type checking
npm run lint
# Releasing
npm run release
```
### Test Structure
The project uses a two-tier testing approach:
- **Regular Tests** (`npm test`): Unit tests, React component tests, and basic integration tests that don't require API keys
- **API Integration Tests** (`npm run test:integration`): Full end-to-end tests that require valid API keys and test actual AI provider integration
This separation allows for fast development cycles while ensuring comprehensive coverage when needed.
## Troubleshooting
### Common Issues
1. **API Key Not Found**
```bash
# Make sure your API key is set
echo $ANTHROPIC_API_KEY
```
2. **No Staged Changes**
```bash
# Make sure you have staged changes first
git add .
# Verify you have staged changes
git diff --cached
```
3. **Generation Failures**
llmc automatically retries up to 3 times if generation fails. You'll see:
```
⠋ Retrying commit message generation (attempt 2/3)...
Previous attempt failed. Retrying... (1 failed attempts)
```
4. **Commit Failures**
If the commit fails, check that:
- You have write permissions to the repository
- You're in a git repository
- There are actually staged changes to commit
### Error Handling
llmc provides detailed error messages and visual feedback:
- ✅ Green checkmark for success
- ❌ Red X for errors
- 🔄 Automatic retry with progress indicators
- ⏱️ Real-time timer showing elapsed time
## License
BSD 3-Clause License - see LICENSE file for details.
## Contributing
Contributions welcome! Please read CONTRIBUTING.md for guidelines.
### Publishing to npm
For maintainers, here's how to publish new versions to npm:
1. **Ensure all tests pass**:
```bash
npm test
npm run test:integration # Run API integration tests if needed
npm run lint
```
2. **Update version in package.json**:
```bash
# Use Conventional Commits to drive release determination
npm run release
# For explicitly specifying patch releases (bug fixes)
npm version patch
# For explicitly specifying minor releases (new features)
npm version minor
# For explicitly specifying major releases (breaking changes)
npm version major
```
3. **Build and publish**:
```bash
# The prepublishOnly script will automatically run 'npm run build'
npm publish
```
4. **Push the version tag**:
```bash
git push origin main --tags
```