@oroooat/lazy-commit
v1.0.0
Published
A @oroooat Production: AI-powered commit message generator with the precision of a Swiss timepiece and the charm of automatically commit
Maintainers
Readme
The Lazy-Commit
A Wes Anderson Production
Chapter I: The Peculiar Case of the Automated Git Commit
In the meticulously organized world of software development, where every pixel must be perfectly aligned and every commit message follows the sacred conventions of the ancient Git masters, there exists a most extraordinary tool. The Lazy-Commit, much like the inhabitants of the Royal Tenenbaums estate, possesses an uncanny ability to transform the mundane into the magnificent.
Starring:
- OpenRouter AI as The Distinguished Cloud Provider
- Ollama as The Eccentric Local Genius
- Your Git Repository as The Grand Hotel Repository
Act II: The Installation Ceremony
[Scene: A perfectly symmetrical terminal window, shot from directly above]
npm install -g @oroooat/lazy-commitOr, for the more adventurous types who prefer the scenic route:
git clone https://github.com/oroooat/lazy-commit.git
cd lazy-commit
npm linkAct III: The Configuration Ritual
The OpenRouter Society
For those who prefer their AI served at precisely 72°F with a side of reliability
- Acquire membership at openrouter.ai/keys
- Present your credentials via environment variable:
export OPENROUTER_API_KEY="your-perfectly-formatted-key-here" - The tool shall remember your key with the precision of a Swiss timepiece
The Ollama Lodge
For the self-sufficient characters who keep their AI models in vintage suitcases
ollama serve
ollama pull llama2 # or your preferred conversationalistAct IV: The Performance
[A single, unbroken shot of a developer's workspace, perfectly arranged]
# Stage your theatrical changes
git add .
# Summon the assistant
lazy-commitThe Experience:
- Select your AI companion (OpenRouter's cosmopolitan charm or Ollama's local expertise)
- Watch as your staged changes are analyzed with the attention to detail of a master filmmaker
- Receive a commit message crafted with the precision of a Mendl's pastry box
- Accept, edit with surgical precision, or politely decline
Act V: The Features Showcase
Security Department
Under the watchful eye of Chief Security Officer Anderson
- Detects sensitive information with the vigilance of a hotel concierge
- Blocks commits containing API keys, passwords, and other contraband
- Maintains the dignity of your repository's reputation
The Memory Palace
- Remembers your preferences like a well-trained butler
- Auto-selects your last-used provider and model
- Configurable skip options for the perpetually decisive
The Editing Suite
- Full message editing capabilities
- Targeted title and bullet-point modifications
- Enhanced formatting tools for the perfectionist
The Retry Mechanism
Because even the best-laid plans occasionally require a second take
- Graceful error handling with multiple recovery options
- Model switching capabilities mid-performance
- Manual message entry for those intimate, personal touches
Act VI: The Command Reference
| Command | Purpose |
|---------|---------|
| lazy-commit | Begin the main performance |
| lazy-commit --reset-config | Return to factory settings, à la fresh hotel stationery |
| lazy-commit --help | Consult the instruction manual |
During Performance:
- Add
rto remember choices (e.g.,1r) - Add
sto skip future prompts (e.g.,2s) - Type
qat any moment to exit gracefully CTRL+Cfor immediate curtain call
Act VII: The Technical Specifications
Requirements:
- Node.js ≥ 14.0.0 (like a well-aged wine)
- Git repository (naturally)
- Internet connection (for OpenRouter performances)
- Ollama installation (for local productions)
Storage:
- Configuration:
~/.auto-commit/config.json - API credentials:
~/.auto-commit/api-key - All stored with museum-quality preservation
Epilogue: The Credits
[Shot in perfect symmetry, with names appearing in Futura font]
Created by: @oroooat
Inspired by: The eternal quest for perfectly crafted commit messages
Special thanks to: The conventional commit specification, without which chaos would surely reign
Runtime: Varies by contemplation speed
Rating: ⭐⭐⭐⭐⭐ "Extraordinarily well-organized" - The Criterion Collection
"In the end, we are all just trying to commit our changes with a little bit of style."
Appendix: Behind the Scenes
This tool employs a sophisticated AI-powered system to analyze your Git diffs and generate conventional commit messages. Like a well-rehearsed ensemble cast, it supports multiple AI providers, remembers your preferences, validates for security concerns, and provides an editing suite worthy of a master craftsman.
The result? Commit messages so precise, so beautifully formatted, that they could be framed and hung in the lobby of The Grand Budapest Hotel.
Fade to perfectly centered credits.
