https://github.com/markolofsen/openrouter-commit
CLI tool that helps you write clear, concise, and AI-generated commit messages using OpenRouter's LLM models.
https://github.com/markolofsen/openrouter-commit
ai aicommits chatgpt commits git gpt node npm openrouter python
Last synced: 3 months ago
JSON representation
CLI tool that helps you write clear, concise, and AI-generated commit messages using OpenRouter's LLM models.
- Host: GitHub
- URL: https://github.com/markolofsen/openrouter-commit
- Owner: markolofsen
- Created: 2025-01-29T08:53:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-08T07:49:46.000Z (over 1 year ago)
- Last Synced: 2025-06-13T19:45:49.061Z (about 1 year ago)
- Topics: ai, aicommits, chatgpt, commits, git, gpt, node, npm, openrouter, python
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/openrouter-commit
- Size: 40 KB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ORCommit
### AI-powered Git commits with security, standards, and full control
> Generate **accurate, conventional, and secure** git commit messages using **OpenAI, Claude, OpenRouter, or local models (Ollama)**.
```bash
git add .
orc commit
```
✔ Conventional Commits
✔ Secret scanning (Gitleaks)
✔ Cloud & local AI
✔ Zero-config to start
---
## TL;DR
**ORCommit** is a production-grade CLI that:
* analyzes your staged git diff
* generates a high-quality commit message via LLMs
* enforces Conventional Commits
* blocks secrets and dependency folders **before** commit
* works with both **cloud and local** AI models
If you care about **clean history, security, and standards** — this tool is for you.
---
## ✨ Key Features
### 🤖 AI Providers
* OpenAI (GPT‑4, GPT‑3.5)
* Claude via OpenRouter (200+ models)
* Local models via **Ollama** (offline & private)
### 🧠 Smart Commit Generation
* Token-aware diff chunking (large repos supported)
* Interactive regeneration with feedback
* Custom prompts & project context
* Conventional Commits by default
### 🔐 Security by Default
* Secret scanning via **Gitleaks** (100+ patterns)
* Blocks API keys, tokens, private keys
* Prevents committing `node_modules/`, `vendor/`, etc.
* Secure API key storage (600 permissions)
### ⚙️ Git-Native Workflow
* Breaking change detection
* Optional push after commit
* Git hooks support
### ⚡ Fast & Reliable
* Memory + disk cache
* Parallel API calls
* Strict TypeScript + comprehensive tests
---
## 🚀 Quick Start
```bash
npm install -g orcommit
orc config set openrouter YOUR_API_KEY
git add .
orc commit
```
That’s it.
---
## 🛠 Common Commands
```bash
orc commit # interactive commit
orc commit --yes # auto-confirm
orc commit --context "..." # extra context
orc commit --emoji # gitmoji
orc commit --breaking # breaking change
orc commit --dry-run # preview only
```
👉 [Full CLI reference](https://github.com/markolofsen/openrouter-commit/blob/main/docs/cli.md)
---
## 🔐 Security Highlights
ORCommit includes **mandatory security checks**:
* 🔍 Secret scanning via **Gitleaks**
* 🚫 Blocks API keys, tokens, private keys
* 🚫 Prevents committing dependency folders
These checks run **before** commit creation and cannot be bypassed accidentally.
👉 [Security details](https://github.com/markolofsen/openrouter-commit/blob/main/docs/security.md)
---
## 💡 Who Is ORCommit For?
* **Teams** — enforce commit standards automatically
* **Open Source** — keep contribution quality high
* **Enterprise** — prevent leaks and ensure compliance
---
## ⚙️ Configuration
Config is stored at `~/.config/orcommit.json` (permissions `600`).
```json
{
"preferences": {
"defaultProvider": "openrouter",
"commitFormat": "conventional",
"temperature": 0.6
}
}
```
Environment variables are also supported:
```bash
export OPENROUTER_API_KEY="your-key"
export OPENAI_API_KEY="your-key"
```
---
## 📚 Documentation
* [CLI Reference](https://github.com/markolofsen/openrouter-commit/blob/main/docs/cli.md)
* [Security Model](https://github.com/markolofsen/openrouter-commit/blob/main/docs/security.md)
* [Architecture](https://github.com/markolofsen/openrouter-commit/blob/main/docs/architecture.md)
* [Advanced Usage](https://github.com/markolofsen/openrouter-commit/blob/main/docs/advanced.md)
---
## 🤝 Contributing
1. Fork the repository
2. Create a feature branch
3. Add tests
4. Submit a pull request
---
## 🏢 About the Maintainers
ORCommit is built and maintained by **[Reforms.ai](https://reforms.ai)** — a team specializing in AI-powered developer tools.
Commercial support, consulting, and custom AI integrations are available.
---
## 📄 License
MIT License — see [LICENSE](LICENSE).
---
Built with ❤️ using TypeScript and modern AI tooling.