commit-message

Generate git commit messages from staged changes with CodeGPT.

1.5k|132|Updated Mar 4, 2023
One-click install
npx skills add https://github.com/appleboy/CodeGPT --skill commit-message-appleboy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-message
Source: https://github.com/appleboy/CodeGPT/tree/main/skills/commit-message
Command: npx skills add https://github.com/appleboy/CodeGPT --skill commit-message-appleboy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation and refinement of git commit messages by analyzing staged changes with AI, saving time and ensuring consistent messaging across projects.

Core Features & Use Cases

  • AI-assisted drafting: Generate commit messages from diffs and staged changes.
  • Language and template support: Specify output language and custom templates to match team standards.
  • Use Case: When committing new features, bug fixes, or refactors, automatically produce clear, concise messages.

Quick Start

Install CodeGPT using the provided script, then configure your AI provider and model, and start generating commit messages from your diffs without manual intervention.

Install CodeGPT: bash < <(curl -sSL https://raw.githubusercontent.com/appleboy/CodeGPT/main/install.sh)

Configure your AI provider in ~/.config/codegpt/.codegpt.yaml:

openai: provider: openai # or: azure, anthropic, gemini, ollama, groq, openrouter api_key: your_api_key_here model: gpt-4o

Basic usage:

  1. Stage your changes: git add <files>

  2. Generate and commit with AI-generated message: codegpt commit --no_confirm

(Note: You don't need to run git diff manually; CodeGPT reads staged changes automatically.)

request: "Automates the creation and refinement of git commit messages from staged changes. It applies to individual developers and teams across software projects for feature, bug fix, and refactor commits. It requires a local CodeGPT setup, git staging, and AI provider configuration, with support for language choice and custom templates."