Transform vague commit messages into clear, convention-compliant professional messages—automatically.

Nova is a production-grade command-line utility that leverages AI to automatically enhance and standardize Git commit messages. It ensures developers maintain clarity, consistency, and adherence to established conventions like Conventional Commits.

• 🤖 AI-Powered Enhancement - Transforms vague messages using OpenAI or Ollama
• 📏 Convention Enforcement - Automatic Conventional Commits compliance
• 🔗 Git Integration - Seamless hook-based automation
• 🌐 Dual Mode - Cloud (OpenAI) and offline (Ollama) support
• ⚡ Lightning Fast - Sub-2-second response times
• 🛡️ Production Ready - Robust error handling and logging

This repository contains comprehensive documentation for understanding, developing, and contributing to Nova:

• New to the project? Start with PROJECT_OVERVIEW
• Want to understand the design? Read ARCHITECTURE
• Planning to contribute? See PROJECT_STRUCTURE and CONTRIBUTING.md
• Looking for examples? Check docs/examples/

npm install -g nova-commit

# Improve a single commit message
nova improve "fixed the bug in login"

# Output:
# ✓ fix(auth): resolve login authentication bug

# Setup automatic enhancement
nova setup
nova install-hooks

# Now commit normally - Nova enhances automatically!
git commit -m "add user feature"
# [nova] Enhanced: feat(user): add user registration feature

Current Phase: Setup & Initial Development ✅

• ✅ Project requirements and architecture design
• ✅ Production folder structure
• ✅ Comprehensive documentation
• ✅ Development environment setup

• 🔄 Core CLI implementation
• 🔄 AI provider integrations
• 🔄 Message processing logic

• ⏳ Git hook integration
• ⏳ Testing infrastructure
• ⏳ Beta release

• Node.js v18 or higher
• Git (for hook integration)
• AI Provider: OpenAI API key OR Ollama (for offline mode)

git commit -m "fix bug"
# Commit message is vague and non-standard

git commit -m "fix bug"
[nova] Enhanced: fix(auth): resolve null pointer exception in user authentication
# Message is clear, formatted, and convention-compliant

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

1. Fork the repository
2. Clone your fork: git clone https://github.com/your-username/nova.git
3. Install dependencies: npm install
4. Create a feature branch
5. Make your changes
6. Run tests: npm test
7. Submit a pull request

• Core CLI functionality
• OpenAI integration
• Basic message improvement
• Unit tests

• Git hook integration
• Ollama (offline) support
• Conventional Commits validation
• Integration tests

• Documentation completion
• Performance optimization
• npm publication
• Community setup

• No Code Transmission: Only commit message text is sent to AI
• Local Option: Ollama mode keeps all data local
• API Key Protection: Secure environment variable handling
• Input Sanitization: Validation and length limits

• Runtime: Node.js v18+ (ES Modules)
• CLI: Commander.js
• AI: OpenAI SDK, Ollama
• Testing: Jest
• Logging: Winston
• Linting: ESLint, Prettier

MIT License - see LICENSE for details.

• Conventional Commits for the commit standard
• OpenAI for GPT models
• Ollama for local AI capabilities

Built with ❤️ for developers who care about code quality

Nova is currently in active development. Documentation and features are subject to change.