1- # Claude Commit - VS Code Extension
1+ # Claude Commit
22
3- AI-powered Git commit message generator using Claude AI. Automatically generates conventional commit messages with a single click.
3+ ** Already using Claude Code? Get the commit message button you deserve – at no extra cost.**
4+
5+ A VS Code extension that brings the ✨ sparkle button to your Git panel, powered by the Claude CLI you already have. Generate intelligent commit messages without paying for additional AI services.
6+
7+ ## Why Claude Commit?
8+
9+ You're already investing in Claude Code – whether it's Pro, Max ×5, or Max ×10. Why pay for Copilot or Cursor just for commit message generation? This extension leverages your existing Claude subscription to bring the same AI-powered commit message functionality directly to VS Code.
10+
11+ ** Zero additional cost. Zero complexity. Just works.**
412
513## Features
614
7- - ** One-Click Generation** : Click the sparkle button in Source Control panel to generate commit messages
8- - ** Conventional Commits** : Generates properly formatted conventional commit messages
9- - ** Bilingual Support** : English and Ukrainian languages
10- - ** Flexible AI Backend** : Works with Claude Code CLI or Anthropic API
11- - ** Smart Fallback** : Automatically tries CLI first, then API
15+ - ** One-click commit message generation** : The sparkle button ✨ you know and love, right in VS Code's Source Control panel
16+ - ** Powered by your Claude CLI** : Uses your existing Claude installation – no extra API keys or subscriptions needed
17+ - ** Context-aware analysis** : Understands your git diff to generate meaningful, conventional commit messages
18+ - ** Bilingual support** : Works in English and Ukrainian
19+ - ** Flexible backend** : Automatically uses Claude CLI, with API fallback option
20+ - ** Seamless VS Code integration** : Works directly with the built-in Git interface
21+
22+ ## Requirements
23+
24+ - VS Code 1.75.0 or higher
25+ - Claude CLI installed and authenticated (comes with your Claude Code subscription)
26+ - Git repository initialized in your workspace
27+ - Internet connection for AI generation
1228
1329## Installation
1430
15- ### From Source
31+ 1 . Install the extension from the VS Code Marketplace
32+ 2 . Ensure Claude CLI is installed and available in your system PATH
33+ 3 . Open a project with a Git repository
34+ 4 . Look for the sparkle ✨ button in your Source Control panel
1635
17- 1 . Clone this repository
18- 2 . Navigate to the ` vscode-extension ` folder
19- 3 . Run ` npm install `
20- 4 . Press F5 to open Extension Development Host
21- 5 . Or run ` vsce package ` to create a .vsix file and install manually
36+ ** That's it!** No configuration needed if you're using Claude CLI.
2237
23- ## Setup
38+ ## How to Use
2439
25- Choose one of the following methods:
40+ 1 . Make your code changes
41+ 2 . Stage your changes (optional – works with unstaged changes too)
42+ 3 . Click the sparkle ✨ button in the Source Control panel
43+ 4 . Review the AI-generated commit message
44+ 5 . Commit
2645
27- ### Option 1: Claude Code CLI (Recommended)
46+ ** No configuration, no setup wizards, no complexity. **
2847
29- Install Claude Code CLI:
30- ``` bash
31- # Follow instructions at https://docs.claude.com/claude-code
32- ```
48+ ## Extension Settings
49+
50+ This extension keeps it simple with just a few optional settings:
3351
34- ### Option 2: Anthropic API
52+ * ` claude-commit.preferredMethod ` : Choose AI backend (` auto ` , ` cli ` , or ` api ` ) – defaults to ` auto `
53+ * ` claude-commit.apiKey ` : Your Anthropic API key (only needed if using API method)
54+ * ` claude-commit.language ` : Interface language (` en ` for English, ` ua ` for Ukrainian)
55+
56+ ## Configuration Examples
57+
58+ ### Using only Claude CLI
59+ ``` json
60+ {
61+ "claude-commit.preferredMethod" : " cli"
62+ }
63+ ```
3564
36- 1 . Get your API key from https://console.anthropic.com/
37- 2 . Add it to VS Code settings:
38- - Open Settings (Cmd+, or Ctrl+,)
39- - Search for "Claude Commit"
40- - Enter your API key in "Claude Commit: Api Key"
65+ ### Using Anthropic API as fallback
66+ ``` json
67+ {
68+ "claude-commit.preferredMethod" : " auto" ,
69+ "claude-commit.apiKey" : " your-api-key-here"
70+ }
71+ ```
4172
42- Or set environment variable:
43- ``` bash
44- export ANTHROPIC_API_KEY=" your-key-here"
73+ ### Ukrainian interface
74+ ``` json
75+ {
76+ "claude-commit.language" : " ua"
77+ }
4578```
4679
47- ## Usage
80+ ## Troubleshooting
81+
82+ ### Claude CLI not found
83+
84+ If the extension can't find Claude CLI:
85+
86+ 1 . ** Check Claude is installed** : Run in terminal:
87+ ``` bash
88+ which claude
89+ ```
90+ This should show the path to Claude (e.g., ` /Users/you/.nvm/versions/node/v22.13.0/bin/claude ` )
4891
49- 1 . Make changes to your code
50- 2 . Stage files with ` git add ` (or use VS Code Source Control UI)
51- 3 . Click the ** sparkle icon** ✨ in the Source Control panel (top right)
52- 4 . The commit message will be automatically generated and inserted into the message box
53- 5 . Review and commit!
92+ 2 . ** Verify authentication** : Ensure Claude CLI is authenticated:
93+ ``` bash
94+ claude setup-token
95+ ```
5496
55- ## Configuration
97+ 3 . ** Common issues** :
98+ - ** NVM users** : VS Code might not see NVM paths – restart VS Code after installing Claude
99+ - ** macOS** : If using zsh, paths might differ between terminal and VS Code
100+ - ** Windows** : Ensure Claude is in your system PATH
56101
57- Open VS Code settings and search for "Claude Commit":
102+ ### No commit message generated
58103
59- - ** API Key ** : Your Anthropic API key (optional if using CLI )
60- - ** Preferred Method ** : Choose between ` auto ` , ` cli ` , or ` api `
61- - ` auto ` : Try CLI first, fallback to API
62- - ` cli ` : Use only Claude Code CLI
63- - ` api ` : Use only Anthropic API
64- - ** Language ** : Choose ` en ` (English) or ` ua ` (Ukrainian)
104+ 1 . Ensure you have changes in your repository (staged or unstaged )
105+ 2 . Check that Claude CLI is properly authenticated
106+ 3 . Try using API method as fallback:
107+ - Get API key from https://console.anthropic.com/
108+ - Add to settings: ` claude-commit.apiKey `
109+ - Set ` claude-commit.preferredMethod ` to ` api `
65110
66- ## Commands
111+ ### Extension not working
67112
68- - ** Claude Commit: Generate Commit Message** - Generate AI-powered commit message
113+ 1 . Check you're in a Git repository
114+ 2 . Open Output panel (View → Output)
115+ 3 . Look for error messages from the extension
116+ 4 . Try generating a commit message manually via Command Palette:
117+ - Press ` Cmd+Shift+P ` (or ` Ctrl+Shift+P ` )
118+ - Type "Claude Commit: Generate"
69119
70- Access via:
71- - Sparkle button in Source Control panel
72- - Command Palette (Cmd+Shift+P / Ctrl+Shift+P) → "Claude Commit: Generate"
120+ ## Privacy & Security
121+
122+ - Your code changes are processed through Claude CLI or Anthropic API
123+ - No data is stored or transmitted by this extension beyond what Claude requires
124+ - Authentication is handled by your existing Claude CLI setup or API key
125+ - Code is only sent to Claude's servers through your authenticated session
73126
74127## Examples
75128
@@ -82,20 +135,20 @@ refactor(store): optimized cart state management
82135docs(readme): updated installation instructions
83136```
84137
85- ## Requirements
138+ ## Contributing
86139
87- - VS Code 1.75.0 or higher
88- - Git repository
89- - One of:
90- - Claude Code CLI installed
91- - Anthropic API key
140+ Found a bug or have a feature request? Please open an issue on our [ GitHub repository] ( https://github.com/uaoa/claude-commit-vscode ) .
141+
142+ ## Author
143+
144+ Created by ** Zakharii Melnyk**
145+ - GitHub: [ @uaoa ] ( https://github.com/uaoa )
146+ - LinkedIn: [ undef-zakhar] ( https://www.linkedin.com/in/undef-zakhar )
92147
93148## License
94149
95- MIT
150+ MIT License - see LICENSE file for details.
96151
97- ## Author
152+ ---
98153
99- Zakharii Melnyk
100- - GitHub: [ @uaoa ] ( https://github.com/uaoa )
101- - LinkedIn: (https://www.linkedin.com/in/undef-zakhar )
154+ ** Stop paying twice for AI commit messages. You've got Claude Code – now get the commit button. ✨**
0 commit comments