Committerr

AI-powered commit messages for VS Code — stay in flow, commit with confidence.

Committerr watches your code changes in real time and generates precise, conventional commit messages using the Groq API. No more staring at a blank terminal trying to summarize what you just built.

How it works

1. Write code — Committerr silently watches your files
2. Switch away from a file — it auto-stages your changes
3. Open the panel — click Generate to get a commit message
4. Press Enter — the command is injected into your terminal, ready to run

Features

• Real-time file tracking — detects changed files as you work, no manual git add needed
• Auto-staging — automatically stages files when you switch away from them
• AI-generated commit messages — follows the Conventional Commits spec using Groq's llama-3.3-70b-versatile model
• Multi-line messages — generates a short title and an explanatory body when changes are complex
• Terminal injection — writes the git commit command directly into your terminal so you review before running
• Sidebar panel — shows changed files and the generated message side by side
• Status bar button — one click to open the Committerr panel from anywhere
• Duplicate panel prevention — clicking the button again focuses the existing panel instead of opening a new one

Installation

From the VS Code Marketplace

Search Committerr in the VS Code Extensions panel (Ctrl+Shift+X) and click Install.

From a .vsix file

code --install-extension committerr-0.0.3.vsix

Or via the UI: Extensions → ··· → Install from VSIX

Setup

1. Get a Groq API key

Sign up at console.groq.com and create a free API key. The free tier is sufficient for everyday use.

2. Add your key to VS Code settings

Open VS Code Settings (Ctrl+,), search for Committerr, and paste your key into the Groq API Key field.

Or add it directly to settings.json:

{
  "committerr.groqApiKey": "gsk_your-key-here"
}

Usage

Panel (recommended)

1. Click Committerr in the status bar at the bottom of VS Code
2. The panel opens showing all changed files
3. Click Generate — the AI reads your staged diff and generates a commit message
4. Review the message, edit if needed, then click Run in Terminal
5. Press Enter in the terminal to commit

Command palette

Open the command palette (Ctrl+Shift+P) and run:

• Generate Commit Message — generates and injects into terminal directly

Configuration

AI Model

Committerr uses llama-3.3-70b-versatile via the Groq API — the best free model available on the platform. Groq's inference is significantly faster than other providers, meaning commit messages generate in under a second in most cases.

The model is instructed to:

• Follow the Conventional Commits format: type(scope): description
• Use only standard types: feat, fix, docs, style, refactor, test, chore, perf, ci, build, revert
• Keep the first line under 72 characters
• Write in present tense
• Add a body when changes are complex, explaining why — not just what

Project Structure

committerr/
├── images/                        # Extension icons and assets
├── out/                           # Compiled JavaScript output (auto-generated)
│   ├── panel/
│   │   └── webviewPanel.html      # Sidebar panel UI (copied from src)
│   └── test/
│       └── extension.test.ts      # Compiled test files
├── src/                           # TypeScript source files
│   ├── extension.ts               # Entry point — registers commands, status bar, watchers
│   ├── gitTracker.ts              # Git API integration — reads staged and unstaged diffs
│   ├── aiGenerator.ts             # Groq API integration — generates commit messages
│   ├── terminalInjector.ts        # Injects git commit command into VS Code terminal
│   └── panel/
│       └── webviewPanel.html      # Sidebar panel UI (HTML/CSS/JS)
├── .env                           # Local environment variables (not committed)
├── .gitignore
├── .vscodeignore                  # Files excluded from the packaged extension
├── .vscode-test.mjs               # VS Code test runner config
├── eslint.config.mjs              # ESLint configuration
├── CHANGELOG.md                   # Version history
├── CONTRIBUTING.md                # Contribution guidelines
├── CODE_OF_CONDUCT.md             # Community standards
├── SECURITY.md                    # Security policy and reporting
├── LICENSE                        # MIT License
├── package.json                   # Extension manifest and dependencies
└── tsconfig.json                  # TypeScript configuration

Contributing

We welcome contributions of all kinds — bug fixes, features, documentation, and feedback.

See CONTRIBUTING.md for the full guide.

Quick start:

git clone https://github.com/dev-ridwan16/committerr.git
cd committerr
npm install
code .
# Press F5 to launch the Extension Development Host

Roadmap

• [ ] PR description generation (Pro)
• [ ] Support for multiple AI providers
• [ ] Configurable commit message format
• [ ] Commit history view in the panel
• [ ] Custom system prompt configuration
• [ ] Team settings sync

Security

If you discover a security vulnerability, please follow the process outlined in SECURITY.md. Do not open a public issue.

License

MIT — see LICENSE for details.

Acknowledgements

• Groq for fast, free LLM inference
• VS Code Extension API for the Git integration and webview APIs
• Conventional Commits for the commit message standard