Appearance
GoCommit Documentation
Welcome to the GoCommit documentation! This collection provides comprehensive guides for using and understanding GoCommit.
📖 Documentation Index
Getting Started
- Overview, installation, and basic usage
- Installation Guide - Detailed installation instructions
Features & Architecture
- JSON Schema Implementation - LangChain-style structured outputs for AI providers ⭐
- Delayed Commit Architecture - Schedule commits with smart time suggestions
- Application Flow - Architecture and workflow diagrams
- Refactoring Summary - Codebase improvements and structure
Configuration & Integration
- GitHub Actions Integration - Automate commit generation in CI/CD
- Logging Guide - Debug and monitor your workflow
- Logging Configuration - Configure logging settings
- Delayed Commit Setup - Configure time-based commits
Additional Resources
- Parsing Fix Summary - Technical details on parsing improvements
- Refactoring Design - Design decisions and patterns
- Dev.to Blog Post - Blog article about GoCommit
🌟 Highlighted Features
JSON Schema & Structured Outputs
GoCommit implements LangChain-style structured outputs for consistent JSON responses from AI providers. See JSON_SCHEMA_IMPLEMENTATION.md for details.
Important: Only certain models support strict JSON schema validation:
- ✅ OpenAI GPT-4o and newer
- ✅ Fireworks-provided models
- ⚠️ Other models rely on enhanced prompting + fallback parsing
Multi-Provider Support
- Gemini via Google AI API
- OpenRouter for access to Claude, GPT-4, Llama, and more
Delayed Commits
Schedule commits for later with intelligent time suggestions based on your work hours.
🚀 Quick Links
📝 Contributing
Contributions are welcome! Please see the main repository for contribution guidelines.
📄 License
MIT License - see repository for details