{"id":23658945,"url":"https://github.com/oh-my-commit/oh-my-commit","last_synced_at":"2025-09-01T13:31:46.836Z","repository":{"id":266591855,"uuid":"898783393","full_name":"oh-my-commit/oh-my-commit","owner":"oh-my-commit","description":"🎨 Oh My Commits，一款专注用户体验、重新定义 Git Commit 的 VSCode 插件，助力你的每一次提交，优雅而专业。","archived":false,"fork":false,"pushed_at":"2024-12-28T22:05:26.000Z","size":4886,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-28T22:21:34.935Z","etag":null,"topics":["ai","anthropic","cli","git-commit","openai","vscode-extension"],"latest_commit_sha":null,"homepage":"https://oh-my-commit.github.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oh-my-commit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-05T02:58:52.000Z","updated_at":"2024-12-28T22:08:21.000Z","dependencies_parsed_at":"2024-12-05T04:19:34.394Z","dependency_job_id":"80e61cb9-353a-48c7-b6fe-0f0273bba29a","html_url":"https://github.com/oh-my-commit/oh-my-commit","commit_stats":null,"previous_names":["cs-magic/yaac","cs-magic-open/yaac","cs-magic-open/oh-my-commit","cs-magic-open/oh-my-commits","oh-my-commit/oh-my-commit"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oh-my-commit%2Foh-my-commit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oh-my-commit%2Foh-my-commit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oh-my-commit%2Foh-my-commit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oh-my-commit%2Foh-my-commit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oh-my-commit","download_url":"https://codeload.github.com/oh-my-commit/oh-my-commit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231693366,"owners_count":18411893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","anthropic","cli","git-commit","openai","vscode-extension"],"created_at":"2024-12-29T01:48:18.601Z","updated_at":"2025-09-01T13:31:46.828Z","avatar_url":"https://github.com/oh-my-commit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n```shell\n                   ____  _       __  __          _____                          _ _   \n                  / __ \\| |     |  \\/  |        / ____|                        (_) |  \n                 | |  | | |__   | \\  / |_   _  | |     ___  _ __ ___  _ __ ___  _| |_ \n                 | |  | | '_ \\  | |\\/| | | | | | |    / _ \\| '_ ` _ \\| '_ ` _ \\| | __|\n                 | |__| | | | | | |  | | |_| | | |___| (_) | | | | | | | | | | | | |_ \n                  \\____/|_| |_| |_|  |_|\\__, |  \\_____\\___/|_| |_| |_|_| |_| |_|_|\\__|\n                                         __/ |                                        \n                                        |___/                                         \n\n```\n\n\u003ch1 align=\"center\"\u003eOh My Commit\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  ✨Your Next-gen AI-powered Commit Solution ✨\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/v/@oh-my-commit/cli?style=flat-square\u0026color=00a8f0\" alt=\"npm version\" /\u003e\n  \u003cimg src=\"https://img.shields.io/npm/dm/@oh-my-commit/cli.svg?style=flat-square\u0026color=00a8f0\" alt=\"downloads\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square\u0026color=00a8f0\" alt=\"License\" /\u003e\n\u003c/p\u003e\n\n\nEnglish | [中文](./README.zh-CN.md) | [Website Docs](https://oh-my-commit.github.io) | [VScode](https://marketplace.visualstudio.com/items?itemName=oh-my-commit.oh-my-commit) | [Open Visx](https://open-vsx.org/extension/oh-my-commit/oh-my-commit) | [Releases](https://github.com/oh-my-commit/oh-my-commit/releases)\n\n![Demo](assets/demo.gif)\n\n\u003c/div\u003e\n\n## Features Comparison\n\n\u003cdiv align=\"center\"\u003e\n✅ Full Support \u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp; ⚠️ Partial Support \u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp; 🚧 In Development \u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp; ➖ Not Supported\n\u003c/div\u003e\n\n\u0026nbsp;\n\n| Features | Oh My Commit | VSCode VCS | JetBrains VCS | Other AI Commit Plugins | AI Commit CLI |\n|---------------|---------|------------|--------------|-------------------|---------------|\n| **Basic Features** |\n| Git Integration | ✅ | ✅ | ✅ | ⚠️ | ➖ |\n| Diff Preview | ✅ | ✅ | ✅ | ➖ | ➖ |\n| Multi-file Commits | ✅ | ✅ | ✅ | ⚠️ | ⚠️ |\n| **AI Features** |\n| Smart Message Generation | ✅ | ➖ | ➖ | ✅ | ✅ |\n| Multi-language Support | ✅ | ➖ | ➖ | ⚠️ | ⚠️ |\n| Custom Algorithm Implementation | ✅ | ➖ | ➖ | ➖ | ➖ |\n| **User Experience** |\n| CLI Support | ✅ | ➖ | ➖ | ➖ | ✅ |\n| GUI Interface | ✅ | ✅ | ✅ | ⚠️ | ➖ |\n| Shortcut Support | 🚧 | ✅ | ✅ | ⚠️ | ➖ |\n| **Advanced Features** |\n| Team Standards Config | 🚧 | ➖ | ⚠️ | ➖ | ➖ |\n| Changesets Integration | 🚧 | ➖ | ➖️ | ➖ | ➖ |\n| Commit Templates | 🚧 | ⚠️ | ✅ | ➖ | ➖ |\n| Commit History Analysis | 🚧 | ✅ | ✅ | ➖ | ➖ |\n| **Extensibility** |\n| Plugin Architecture | ✅ | ✅ | ✅ | ➖ | ➖ |\n| Custom Workflows | 🚧 | ⚠️ | ✅ | ➖ | ➖ |\n\n## UI Comparison\n\n![panel comparison](assets/panel-comparison.png)\n\n## System Architecture\n\nOh My Commit is a modular intelligent commit solution:\n\n- **Multi-platform Support**\n  - CLI Tool: Standalone command-line program for use in any terminal\n  - VSCode Extension: Graphical interface with silent and interactive modes\n  - Future Plans: Support for more IDEs and platforms\n\n- **Core Components**\n  - Shared Configuration: Cross-platform unified user settings and team standards\n  - Algorithm Marketplace: Customizable AI commit algorithms with extensible provider system\n  - Data Analytics: Commit history analysis and team collaboration insights (planned)\n\n- **Technical Features**\n  - Monorepo Architecture: Multi-package management with pnpm\n  - Module Decoupling: Separation of core logic, UI, and algorithm providers\n  - Plugin Design: Support for third-party extensions and customization\n\n## AI Capabilities\n\n- **Multi-model Support**\n\n  - Built-in Oh My Commit professional model optimized for code commits\n  - Support for OpenAI GPT-3.5/4, Claude, and other mainstream models\n  - Customizable AI service endpoints for flexible expansion\n\n- **Provider Installation**\n\n  - Install official provider via npm:\n    ```bash\n    # Install globally\n    npm install -g @oh-my-commit/provider-official\n    \n    # Or install locally in your project\n    npm install @oh-my-commit/provider-official\n    ```\n  - Provider files will be automatically installed to `~/.oh-my-commit/providers/official/`\n  - Custom providers can be installed to the same directory structure\n\n- **Intelligent Analysis**\n\n  - Deep understanding of code change context\n  - Automatic identification of refactoring, bugfix, feature types\n  - Generate commit messages matching team style\n\n- **Continuous Optimization**\n  - Continuous improvement based on user feedback\n  - Regular model capability updates\n  - Support for custom training fine-tuning\n\n## Usage\n\n\u003e ⚠️ **Pre-usage Configuration**\n\u003e \n\u003e Taking the official algorithm `@oh-my-commit/provider-official` as an example, you need to:\n\u003e 1. Configure AI service key: `ANTHROPIC_API_KEY` or VSCode setting `oh-my-commit.apiKeys.anthropic`\n\u003e 2. (Optional) Configure proxy:\n\u003e    - CLI: `HTTP_PROXY` environment variable\n\u003e    - VSCode: `ohMyCommit.proxy.url` and `ohMyCommit.proxy.enabled`\n\n\u003e CLI and VSCode can be used independently with shared synchronized configuration\n\n### CLI Usage\n\n```bash\n# Install CLI tool globally\nnpm install -g oh-my-commit\n\n# Install official AI Commit algorithm implementation\n# Third-party directory: `~/.oh-my-commit/providers/`\nnpm install -g @oh-my-commit/provider-official\n\n# Use in git repository\nomc  # View help\nomc gen # AI generate commit\n```\n\n### VSCode Extension\n\n1. Install \"[**Oh My Commit**](https://marketplace.visualstudio.com/items?itemName=oh-my-commit.oh-my-commit)\" from VSCode marketplace\n2. Usage methods:\n   - Shortcut: `cmd+shift+p` search for \"OMC: Quick Commit\"\n   - Status Bar: Click the Commit icon in status bar\n   - Source Control: Use VSCode's built-in Git panel\n\n## Configuration\n\n| Setting                                | Type    | Default                      | Description                                   | Options                                                                                                    |\n| -------------------------------------- | ------- | ---------------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |\n| `oh-my-commit.model.id`                | string  | \"omc-standard\"    | Select AC service provider and model          | • `omc-standard`\u003cbr\u003e• (Custom implementations via local install / source PR / npm publish)        |\n| `oh-my-commit.git.lang`                | string  | \"system\"                     | Git commit message language                    | • `system`: Follow system language\u003cbr\u003e• `zh_CN`: Chinese commit messages\u003cbr\u003e• `en_US`: English commit messages |\n| `oh-my-commit.apiKeys`              | object  | -                           | AI service provider API key configuration      |                                                                                                            |\n| `oh-my-commit.ui.mode`                 | string  | \"panel\"                      | Commit interface mode                          | • `notification`: Generate commit messages via notifications, ideal for quick personal development\u003cbr\u003e• `panel`: Resident panel with professional view supporting title/content editing and diff viewing, suitable for professional collaboration |\n| `ohMyCommit.proxy.enabled`             | boolean | false                       | Enable proxy for API requests                  | `true / false`                                                                                              |\n| `ohMyCommit.proxy.url`                 | string  | \"http://localhost:7890\"     | Proxy server URL                              | Any valid proxy URL (e.g. \"http://localhost:7890\")                                                          |\n\nNote: Our omc-standard requires users to configure their own ANTHROPIC_API_KEY and proxy (if necessary), which can be set in user settings.\n\n## Acknowledgments\n\nThis project is inspired by and builds upon the work of several excellent projects:\n\n- [vscode-i-dont-care-about-commit-message](https://github.com/mefengl/vscode-i-dont-care-about-commit-message) - VSCode extension inspiration\n- [gcop](https://github.com/undertone0809/gcop) - CLI implementation inspiration\n\n## Contributors\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/markshawn2020\"\u003e\n    \u003cimg src=\"https://github.com/markshawn2020.png\" width=\"50\" height=\"50\" alt=\"markshawn2020\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## Built With\n\n- [Windsurf Editor by Codeium](https://codeium.com/windsurf) - Development Environment\n- [Claude](https://claude.ai) - AI Assistant\n\n## Contributing\n\nContributions are welcome! Please check our [Contributing Guide](CONTRIBUTING.md) for details.\n\n## Support\n\nIf you encounter any issues or have suggestions:\n\n1. Check the [FAQ](docs/guide/faq.md)\n2. Submit an [Issue](https://github.com/oh-my-commit/oh-my-commit/issues)\n\n## License\n\nOh My Commit is licensed under [MIT + Commons Clause](./LICENSE). This means:\n\n- ✅ You can freely use, modify, and distribute this software\n- ✅ You can use this software in personal or internal projects\n- ✅ You can create and distribute modified versions\n- ❌ You cannot sell this software as a paid service or product\n- ❌ You cannot commercialize this software without authorization\n\nIf you want to use Oh My Commit in a commercial environment, please contact us for a commercial license.\n\nFor detailed terms, please check the [LICENSE](./LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foh-my-commit%2Foh-my-commit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foh-my-commit%2Foh-my-commit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foh-my-commit%2Foh-my-commit/lists"}