CommitMuse

CommitMuse is a VS Code extension that uses AI to generate Git commit messages from your current repository changes.

Features

• Generate a commit message from staged and unstaged Git changes.
• Fill the VS Code Source Control commit input directly.
• Preview a full AI-generated summary in Markdown.
• Stream preview output when using an OpenAI-compatible endpoint.
• Configure AI endpoint, API key, model, request format, output language, and prompt behavior from the CommitMuse sidebar.
• Use built-in Alibaba-style or Tencent-style commit conventions.
• Detect common project commit rule files such as commitlint.config.cjs, .commitlintrc, .czrc, .gitmessage, and CONTRIBUTING.md.
• Add your own custom prompt.

Requirements

You need an AI endpoint that accepts one of these request formats.

Simple format:

{
  "prompt": "string",
  "model": "optional model name"
}

OpenAI-compatible format:

{
  "model": "model name",
  "messages": [
    {
      "role": "user",
      "content": "prompt"
    }
  ],
  "temperature": 0.2,
  "stream": true
}

When OpenAI-compatible format is selected and the endpoint ends with /v1, CommitMuse sends requests to /v1/chat/completions.

Usage

1. Open a Git repository in VS Code.
2. Open the CommitMuse sidebar.
3. Configure your AI endpoint and optional API key/model.
4. Choose a commit convention source.
5. Click Generate to SCM Input, or use the sparkle button in the Source Control title bar.

中文用法与功效

CommitMuse 用于帮助开发者根据当前 Git 修改自动生成提交信息。安装插件后，打开左侧 CommitMuse 面板，配置你的 AI 接口地址、API Key、模型名称和请求格式，然后选择提交规范来源。插件内置阿里巴巴风格和腾讯风格提交规范，也会自动识别当前项目中的 commitlint.config.cjs、.commitlintrc、.czrc、.gitmessage、CONTRIBUTING.md 等常见规范文件。

日常使用时，你可以在源代码管理面板点击 sparkle 按钮，插件会读取当前 staged 和 unstaged 修改，结合选择的提交规范与自定义提示词，生成一条可直接使用的 commit message 并填入提交框。你也可以在 CommitMuse 面板中点击预览完整结果，查看按文件总结、推荐提交信息和注意事项；如果使用 OpenAI 兼容接口，还可以开启流式预览，让内容边生成边显示。

它适合用于减少重复编写提交信息的时间，统一团队提交格式，提高 Git 历史可读性，并在提交前快速理解本次修改范围。对于多人协作项目，建议优先选择项目已有的提交规范文件；如果项目没有规范文件，可以使用插件内置的阿里巴巴或腾讯提交规范作为默认规则。

Extension Settings

CommitMuse contributes these settings:

• commitmuse.apiEndpoint: AI endpoint used to generate commit messages.
• commitmuse.apiKey: Optional Bearer token.
• commitmuse.model: Optional model name.
• commitmuse.requestFormat: simple or openaiCompatible.
• commitmuse.useDefaultPrompt: Include CommitMuse built-in prompt instructions.
• commitmuse.outputLanguage: zh-CN, en, or zh-TW.
• commitmuse.commitRuleSource: Built-in rule or detected project rule file.
• commitmuse.customPrompt: Additional custom prompt.
• commitmuse.enableStreaming: Enable streaming preview output.
• commitmuse.maxDiffBytes: Maximum Git diff bytes sent to the AI endpoint.
• commitmuse.includeStaged: Include staged changes.
• commitmuse.includeUnstaged: Include unstaged changes.

Privacy

CommitMuse sends Git status, selected Git diffs, selected commit rule content, and prompt configuration to the AI endpoint you configure. Do not configure an endpoint you do not trust.

Known Limitations

• Untracked file contents are not included yet; Git status will still show them.
• Streaming is currently used for preview mode with OpenAI-compatible endpoints.
• Filling the SCM commit input waits for a complete response to avoid writing partial commit messages.

Release Notes

0.0.1

Initial preview release.