Skip to content

updated README.md to include the ollama setup #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 5, 2025
Merged

updated README.md to include the ollama setup #51

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e1d4f2
updated README.md to include the ollama setup
vinyas-bharadwaj Oct 5, 2025
d9e1ac1
Merge branch 'main' into ollama
vinyas-bharadwaj Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Looking to contribute? Check out:
## Features

✨ **AI-Powered Commit Messages** - Automatically generate meaningful commit messages
🔄 **Multiple LLM Support** - Choose between Google Gemini, Groq, Grok, Claude or ChatGPT
🔄 **Multiple LLM Support** - Choose between Google Gemini, Grok, Claude, ChatGPT, or Ollama (local)
📝 **Context-Aware** - Analyzes staged and unstaged changes
📋 **Auto-Copy to Clipboard** - Generated messages are automatically copied for instant use
📊 **File Statistics Display** - Visual preview of changed files and line counts
Expand All @@ -37,18 +37,19 @@ Looking to contribute? Check out:

## Supported LLM Providers

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

### Environment Variables

| Variable | Values | Description |
| :--------------- | :----------------------------------------------- | :------------------------ |
| `COMMIT_LLM` | `gemini`, `groq`, `grok`, `claude`, or `chatgpt` | Choose your LLM provider |
| `GEMINI_API_KEY` | Your API key | Required if using Gemini |
| `GROQ_API_KEY` | Your API key | Required if using Groq |
| `GROK_API_KEY` | Your API key | Required if using Grok |
| `CLAUDE_API_KEY` | Your API key | Required if using Claude |
| `OPENAI_API_KEY` | Your API key | Required if using ChatGPT |
| Variable | Values | Description |
| :--- | :--- | :--- |
| `COMMIT_LLM` | `gemini`, `grok`, `claude`, `chatgpt`, or `ollama` | Choose your LLM provider |
| `GEMINI_API_KEY` | Your API key | Required if using Gemini |
| `GROK_API_KEY` | Your API key | Required if using Grok |
| `CLAUDE_API_KEY` | Your API key | Required if using Claude |
| `OPENAI_API_KEY` | Your API key | Required if using ChatGPT |
| `OLLAMA_URL` | URL (optional) | Ollama server URL (default: http://localhost:11434/api/generate) |
| `OLLAMA_MODEL` | Model name (optional) | Ollama model to use (default: qwen2:0.5b) |

---

Expand Down Expand Up @@ -193,6 +194,17 @@ commit .
2. Create a new API key
3. Set the `OPENAI_API_KEY` environment variable

**Ollama (Local LLM):**

1. Install Ollama: Visit [Ollama.ai](https://ollama.ai/) and follow installation instructions
2. Start Ollama: `ollama serve`
3. Pull a model: `ollama pull llama3`
4. Set environment variables:
```bash
export COMMIT_LLM=ollama
export OLLAMA_MODEL=llama3 # llama3 by default
```
Comment on lines +203 to +206
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Resolve conflicting Ollama default model docs.

Line 52 documents OLLAMA_MODEL defaulting to qwen2:0.5b, but Line 198 claims the default is llama3. Please pick the correct value and update both locations so readers aren’t misconfigured.

🤖 Prompt for AI Agents 
In README.md around lines 52 and 196-199, the documented default for
OLLAMA_MODEL is inconsistent (qwen2:0.5b at line 52 vs llama3 at ~198); choose
the correct canonical default value for OLLAMA_MODEL and update both occurrences
to match exactly (including the example export lines and any inline comment),
and search the rest of the README for other mentions of OLLAMA_MODEL to make
them consistent as well.


---

## 🤝 Contributing
Expand Down
Loading