Skip to content

Generate commit based on AI, thanks to the gitmoji project

License

Notifications You must be signed in to change notification settings

dweb-channel/ai-commit

Repository files navigation

AI Commit

AI-powered Git commit message generator for VS Code with Gitmoji support.

alt text

alt text

Features

  • AI-Powered Commit Messages: Generate commit messages using AI based on your staged changes
  • Multiple AI Providers: Support for DeepSeek, Zhipu AI (GLM), and OpenAI-compatible APIs
  • Conventional Commits: Generate messages following the Conventional Commits specification
  • Style Learning: Analyze your commit history to match your project's commit style
  • Multi-language Support: Generate commit messages in English or Chinese
  • Gitmoji Integration: Built-in Gitmoji support for adding emojis to your commits

Supported AI Providers

Provider Description
DeepSeek Fast and affordable
Zhipu AI (GLM) Chinese language optimized
OpenAI Compatible Connect to any OpenAI-compatible API

Usage

  1. Stage your changes with git add
  2. Click the sparkle icon in the SCM panel
  3. Wait for AI to generate the commit message
  4. Review and commit!

Configuration

Open VS Code Settings and search for "AI Commit" to configure:

AI Provider Settings

  • aiCommit.provider: Select AI provider (deepseek/zhipu/openai)
  • aiCommit.deepseek.apiKey: DeepSeek API Key
  • aiCommit.zhipu.apiKey: Zhipu AI API Key (format: api_key.secret)
  • aiCommit.openai.apiKey: OpenAI Compatible API Key
  • aiCommit.openai.endpoint: Custom API endpoint for OpenAI-compatible services

General Settings

  • aiCommit.language: Commit message language (auto/en/zh)
  • aiCommit.includeEmoji: Include emoji in commit messages
  • aiCommit.historyCount: Number of historical commits to analyze for style learning
  • aiCommit.maxDiffLength: Maximum diff length to send to AI

Gitmoji Features

This extension also includes Gitmoji functionality:

  • Click the smiley icon in SCM panel to choose a Gitmoji
  • Configure emoji output type (emoji or code)
  • Add custom emojis
  • Auto-match emojis based on commit message

License

MIT

About

Generate commit based on AI, thanks to the gitmoji project

Resources

License

Stars

Watchers

Forks

Packages

No packages published