____  _       __  __          _____                          _ _   
                  / __ \| |     |  \/  |        / ____|                        (_) |  
                 | |  | | |__   | \  / |_   _  | |     ___  _ __ ___  _ __ ___  _| |_ 
                 | |  | | '_ \  | |\/| | | | | | |    / _ \| '_ ` _ \| '_ ` _ \| | __|
                 | |__| | | | | | |  | | |_| | | |___| (_) | | | | | | | | | | | | |_ 
                  \____/|_| |_| |_|  |_|\__, |  \_____\___/|_| |_| |_|_| |_| |_|_|\__|
                                         __/ |                                        
                                        |___/                                         

Oh My Commit is a modular intelligent commit solution:

• Multi-platform Support

  • CLI Tool: Standalone command-line program for use in any terminal
  • VSCode Extension: Graphical interface with silent and interactive modes
  • Future Plans: Support for more IDEs and platforms

• Core Components

  • Shared Configuration: Cross-platform unified user settings and team standards
  • Algorithm Marketplace: Customizable AI commit algorithms with extensible provider system
  • Data Analytics: Commit history analysis and team collaboration insights (planned)

• Technical Features

  • Monorepo Architecture: Multi-package management with pnpm
  • Module Decoupling: Separation of core logic, UI, and algorithm providers
  • Plugin Design: Support for third-party extensions and customization

• Multi-model Support

  • Built-in Oh My Commit professional model optimized for code commits
  • Support for OpenAI GPT-3.5/4, Claude, and other mainstream models
  • Customizable AI service endpoints for flexible expansion

• Provider Installation

  • Install official provider via npm:

    # Install globally
    npm install -g @oh-my-commit/provider-official
    
    # Or install locally in your project
    npm install @oh-my-commit/provider-official

  • Provider files will be automatically installed to ~/.oh-my-commit/providers/official/
  • Custom providers can be installed to the same directory structure

• Intelligent Analysis

  • Deep understanding of code change context
  • Automatic identification of refactoring, bugfix, feature types
  • Generate commit messages matching team style

• Continuous Optimization

  • Continuous improvement based on user feedback
  • Regular model capability updates
  • Support for custom training fine-tuning

⚠️ Pre-usage Configuration

Taking the official algorithm @oh-my-commit/provider-official as an example, you need to:

1. Configure AI service key: ANTHROPIC_API_KEY or VSCode setting oh-my-commit.apiKeys.anthropic
2. (Optional) Configure proxy:
   • CLI: HTTP_PROXY environment variable
   • VSCode: ohMyCommit.proxy.url and ohMyCommit.proxy.enabled

CLI and VSCode can be used independently with shared synchronized configuration

# Install CLI tool globally
npm install -g oh-my-commit

# Install official AI Commit algorithm implementation
# Third-party directory: `~/.oh-my-commit/providers/`
npm install -g @oh-my-commit/provider-official

# Use in git repository
omc  # View help
omc gen # AI generate commit

1. Install "Oh My Commit" from VSCode marketplace
2. Usage methods:
   • Shortcut: cmd+shift+p search for "OMC: Quick Commit"
   • Status Bar: Click the Commit icon in status bar
   • Source Control: Use VSCode's built-in Git panel

Note: Our omc-standard-claude-3.5 requires users to configure their own ANTHROPIC_API_KEY and proxy (if necessary), which can be set in user settings.

This project is inspired by and builds upon the work of several excellent projects:

• vscode-i-dont-care-about-commit-message - VSCode extension inspiration
• gcop - CLI implementation inspiration

• Windsurf Editor by Codeium - Development Environment
• Claude - AI Assistant

Contributions are welcome! Please check our Contributing Guide for details.

If you encounter any issues or have suggestions:

1. Check the FAQ
2. Submit an Issue

Oh My Commit is licensed under MIT + Commons Clause. This means:

• ✅ You can freely use, modify, and distribute this software
• ✅ You can use this software in personal or internal projects
• ✅ You can create and distribute modified versions
• ❌ You cannot sell this software as a paid service or product
• ❌ You cannot commercialize this software without authorization

If you want to use Oh My Commit in a commercial environment, please contact us for a commercial license.

For detailed terms, please check the LICENSE file.