Skip to content

Commit f93c76b

Browse files
authored
Merge pull request #27 from TheVijayVignesh/main
docs: Add documentation for Claude LLM provider
2 parents a084f4c + 80b6f0a commit f93c76b

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Looking to contribute? Check out:
2828
## Features
2929

3030
**AI-Powered Commit Messages** - Automatically generate meaningful commit messages
31-
🔄 **Multiple LLM Support** - Choose between Google Gemini, Grok, or ChatGPT
31+
🔄 **Multiple LLM Support** - Choose between Google Gemini, Grok, Claude or ChatGPT
3232
📝 **Context-Aware** - Analyzes staged and unstaged changes
3333
📋 **Auto-Copy to Clipboard** - Generated messages are automatically copied for instant use
3434
📊 **File Statistics Display** - Visual preview of changed files and line counts
@@ -37,16 +37,17 @@ Looking to contribute? Check out:
3737

3838
## Supported LLM Providers
3939

40-
You can use either **Google Gemini** or **Grok** as the LLM to generate commit messages:
40+
You can use **Google Gemini**, **Grok**, **Claude**, or **ChatGPT** as the LLM to generate commit messages:
4141

4242
### Environment Variables
4343

44-
| Variable | Values | Description |
45-
| ---------------- | ---------------------------------------- | ------------------------- |
46-
| `COMMIT_LLM` | `gemini`, `grok`, `claude`, or `chatgpt` | Choose your LLM provider |
47-
| `GEMINI_API_KEY` | Your API key | Required if using Gemini |
48-
| `GROK_API_KEY` | Your API key | Required if using Grok |
49-
| `OPENAI_API_KEY` | Your API key | Required if using ChatGPT |
44+
| Variable | Values | Description |
45+
| :--- | :--- | :--- |
46+
| `COMMIT_LLM` | `gemini`, `grok`, `claude`, or `chatgpt` | Choose your LLM provider |
47+
| `GEMINI_API_KEY` | Your API key | Required if using Gemini |
48+
| `GROK_API_KEY` | Your API key | Required if using Grok |
49+
| `CLAUDE_API_KEY` | Your API key | Required if using Claude |
50+
| `OPENAI_API_KEY` | Your API key | Required if using ChatGPT |
5051

5152
---
5253

@@ -172,6 +173,12 @@ commit .
172173
2. Generate an API key
173174
3. Set the `GROK_API_KEY` environment variable
174175

176+
**Claude (Anthropic):**
177+
178+
1. Visit the [Anthropic Console](https://console.anthropic.com/)
179+
2. Create a new API key
180+
3. Set the `CLAUDE_API_KEY` environment variable
181+
175182
**OpenAI (ChatGPT):**
176183

177184
1. Visit [OpenAI Platform](https://platform.openai.com/api-keys)

0 commit comments

Comments
 (0)