Skip to content

Commit 26bac47

Browse files
authored
Merge pull request #51 from vinyas-bharadwaj/ollama
updated README.md to include the ollama setup
2 parents 43b0e8c + d9e1ac1 commit 26bac47

1 file changed

Lines changed: 22 additions & 10 deletions

File tree

README.md

Lines changed: 22 additions & 10 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, Groq, Grok, Claude or ChatGPT
31+
🔄 **Multiple LLM Support** - Choose between Google Gemini, Grok, Claude, ChatGPT, or Ollama (local)
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,18 +37,19 @@ Looking to contribute? Check out:
3737

3838
## Supported LLM Providers
3939

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

4242
### Environment Variables
4343

44-
| Variable | Values | Description |
45-
| :--------------- | :----------------------------------------------- | :------------------------ |
46-
| `COMMIT_LLM` | `gemini`, `groq`, `grok`, `claude`, or `chatgpt` | Choose your LLM provider |
47-
| `GEMINI_API_KEY` | Your API key | Required if using Gemini |
48-
| `GROQ_API_KEY` | Your API key | Required if using Groq |
49-
| `GROK_API_KEY` | Your API key | Required if using Grok |
50-
| `CLAUDE_API_KEY` | Your API key | Required if using Claude |
51-
| `OPENAI_API_KEY` | Your API key | Required if using ChatGPT |
44+
| Variable | Values | Description |
45+
| :--- | :--- | :--- |
46+
| `COMMIT_LLM` | `gemini`, `grok`, `claude`, `chatgpt`, or `ollama` | 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 |
51+
| `OLLAMA_URL` | URL (optional) | Ollama server URL (default: http://localhost:11434/api/generate) |
52+
| `OLLAMA_MODEL` | Model name (optional) | Ollama model to use (default: qwen2:0.5b) |
5253

5354
---
5455

@@ -193,6 +194,17 @@ commit .
193194
2. Create a new API key
194195
3. Set the `OPENAI_API_KEY` environment variable
195196

197+
**Ollama (Local LLM):**
198+
199+
1. Install Ollama: Visit [Ollama.ai](https://ollama.ai/) and follow installation instructions
200+
2. Start Ollama: `ollama serve`
201+
3. Pull a model: `ollama pull llama3`
202+
4. Set environment variables:
203+
```bash
204+
export COMMIT_LLM=ollama
205+
export OLLAMA_MODEL=llama3 # llama3 by default
206+
```
207+
196208
---
197209

198210
## 🤝 Contributing

0 commit comments

Comments
 (0)